The technical writing process

technical writing이 반드시 'writing'에만 국한되지는 않는다.

technical writing에서 필요한 작업은 visual design, editing 그리고 project management 등을 포함함.

TW는 이 중 일부를 하게 될 수도 있고 아니면 혼자 다하게 될 수도 있음

why? 심심찮게 테크니컬 라이터가 1명인 곳도 많으므로.

 

What you can expect (maybe)

1. Identify the needed deliverables

deliverables이란 최종 산출물, final products를 말함

e.g. books, online help, web pages, tutorials, videos 등등

2. Develop an outline or a plan for each deliverable

3. Create an overall project plan with a list of tasks for each deliverable and a draft schedule.

Tasks include

• outlining
• creating storyboards
• writing
• editing
• designing visual content
• reviewing
• and so on

4. Design the content's template or get your department's existing template.

A template contains

• paragraph styles
• layouts
• other formatting information
• definitions for a document's structure

5. Create the content

6. Create the visuals

e.g. still images, content with motion and audio

7. Get the information reviewed by SMEs.

8. Edit the information and then have the material reviewed by a peer or technical editor.

changes 있으면 기록하기

9. Index the content

10. Product the material

 

but 위의 과정은 진짜 말 그대로 이상적인 거고..

실무를 하다보면 각종 변수가 생긴다 ^.ㅠ

 

예를 들어, 실컷 초안 다 작성해놨더니 갑자기 신규 기능 엄청 추가됨

결국 신규 기능 문서화 하고 테스트함

근데 또 개발자들이 어떤 기능은 TW한테 얘기도 안하고 빼버림

다른 개발자랑 확인해보니 해당 기능들은 그냥 임시로 disabled 한거라고 함

(이래서 TW와 개발자가 평소에 업데이트가 잘되고

원활하게 커뮤니케이션 하는게 중요한듯...!!)

-> 이건 하나의 예시이고

문서 작업 과정이 이만큼 예상대로 순순히(?) 흘러가진 않을 수도 있다는 얘기

 

어쨌든 이렇게 변수가 생기면 TW는 결정을 해야 한다.

document를 release 하기 전에 해당 기능을 넣을 수 있을까?

아니면 콘텐츠를 빼버릴까?

 

개인적인 의견으로는 요즈음의 docs는 보통 web 기반이기 때문에

사실 중간 중간에 빠진 내용 업데이트하거나 수정하는데 크게 부담되는 일은 별로 없다.

다만, 공공기관 같이 여전히 paper-based deliverable을 선호하는 곳은 프린트 되고 나서 고치려고 하면 일이 커질 수 있으므로-

(PM이 없는 곳이라면) TW로서 PM (Project Management) 능력도 발휘해야 함.

 

TW 부서는 template에 기반한 접근 방식을 취해야 함

Authoring with templates and with structure

the methodology for developing technical content into four levels:

Chaos 🙅‍♀️

그냥 말 그대로 일관성도 없고 엉망진창임

글쓰는 사람마다 각자 스타일도 다름

Page consistency 🙅‍♀️

겉으로 보기엔 콘텐츠가 같아 보이는데

source file보면 아님, 일관성이 없음

e.g. 어떤 사람은 들여쓰기 하려고 tab space하고

다른 사람은 space bar를 5번 침

-> 이렇게 각자 다른 방식으로 따르고 standard가 없으면 시간 낭비할 가능성 높음

효율성도 떨어지고 콘텐츠 quality도 저하된다.

Template-based authoring 🙆‍♀️

template은 미리 정해진 스타일이 있기 때문에-

어떤 특정 formatting을 만들어내기 위해 시간을 소비할 필요가 없음

 

so template과 style guide 중요 ⭐️⭐️⭐️

guide에서 어떤 스타일을 따를지 정의함

• A heading must be followed by an introductory paragraph.
• A bulleted list must contain at least two items.
• A graphic must have a caption.

Structured authoring 🙆‍♀️

structured authoring이란? a publishing work flow that defines and enforces consistent organization of content

structured authoring은 template-based authoring에서 한 단계 더 나아갔다고 보면 됨

How? template에서 a hierarchy (위계 구조)를 정의함

Are templates and structure really that important?

Yes, they are. It's essential to have streamlined processes in place, and templates and structure boost authors' efficiency.

 

Template과 structure는 single sourcing의 기반이 됨

single sourcing이란? the process of using one set of files to create

• Different versions of content

예를 들어서 2개의 프린터가 있는데 이 두 프린터가 공통 기능들이 있음

그럼 2개 메뉴얼에 이 공통 기능들을 포함하고

이 중 하나의 프린터에만 있는 기능은 해당 가이드에만 추가하면 됨

• Multiple types of output

deliverable이 여러 종류가 있다고 가정

e.g. printed books, online help and web pages

single sourcing을 하면 이 각각의 다른 산출물을 위한 서로 다른 source file을 만들어서 유지할 필요가 없음

Single sourcing means writing content once and using it in multiple places.

 

출처: Technical Writing 101