e.g. mindMup, SimpleMind
Structured authoring 하려면 결국 툴의 도움을 받으면 좋다
- 구조가 명확하게 보여서 편집하기 좋음
- 마인드맵 보여주면서 TOC 설명, 공유하면 이해하기 쉬움
Structured authoring이란?
a publishing workflow that defines and enforces consistent organization of information
정보의 일관된 구조를 정의하고 강화하는 publishing 작업 흐름이다.
간단한 구조화된 document 예시로 recipe를 들 수 있음
보통 전형적인 recipe는 여러가지 구성 요소를 필요로 함
- a name
- a list of ingredients
- instructions
요리책에 대한 스타일 가이드에서 list of ingredients가 항상 instructions보다 순서에서 먼저 나와야 한다고 설명함
structured 환경에서는 recipe 구조가 특정 organization을 따름
Elements and hierarchy
Structured authoring은 elements에 기반함
element란? a unit of content 콘텐츠의 한 단위
text가 될수도 있고 다른 element가 될수도 있음
node와 branch의 set으로 elements의 hierarchy를 살펴볼 수 있음
Elements는 hierarchical trees (계층화된 구조 모양)으로 organize 될 수 있음
e.g. Recipe에서 하위 계층구조인 ingredient list는 ingredient를 포함할 수 있음
여기서 ingredients는 또 items, quantities, preparation method 등의 구성 요소를 포함할 수 있음
element hierarchy를 쓰면 좋은 점?
관련 정보를 분명하게 관련지을 수 있음
위의 structure에서는 IngredientList element가 Recipe element의 child 자식이구나라는 걸 명시함
IngredientList는 각각의 Ingredient 요소를 포함하고
Ingredient는 또 Item, Quantity, Preparation 등 2~3개의 child elements를 포함함
이런 식으로 상위, 하위 계층과 구조를 명확하게 구분할 수 있음
structured documents에서 쓰이는 주요 용어
- Tree - 구성 요소의 계층형 순서
e.g. family tree
- Branch - 계층화된 트리의 한 부분
- Leaf - descendant 자손 element를 가지지 않은 element
e.g. Name
- Parent/ child - child element는 parent보다 hierarchy에서 한 레벨 낮은 단계
e.g. Name, IngredientList, Instructions는 모두 Recipe의 children
- Sibling - 구성 요소들이 hierarchy에서 동일한 수준에 위치해있고, 동일한 parent element를 가지고 있을 때 이들을 sibling이라고 함
e.g. Item, Quantity, and Preparation
Element attributes
element에 관한 additional information을 attribute에 저장할 수 있음
attribute란? 특정 element와 관련된 name-value로 쌍을 이루는 정보임
attribute가 있으면 좋은 점?
정보를 좀 더 분류할 수 있는 방법을 제공함
e.g. 각각의 recipe가 cuisine명이 부여되면, American 음식 recipe가 필요하다?할 때 attribute를 검색해서 쉽게 찾을 수 있음
만약에 structured content가 database에 저장되면, attribute는 구체적인 정보를 검색할 수 있는 수단이 됨
attribute를 information about information (a.k.a metadata)로 활용할 수 있다.
출처: Technical Writing 101
'Technical Writing' 카테고리의 다른 글
The technical writing process (0) | 2022.07.13 |
---|---|
Visual Communication 사례 조사 (0) | 2022.07.04 |
Final preparation - production editing (0) | 2022.06.08 |
The importance of being edited (0) | 2022.06.08 |
Writing task-oriented information (0) | 2022.06.08 |