Very necessary evils - doc plans and outlines

doc plan과 outline을 짜기 위해선 제품에 관한 대략적인 정보가 필요함

e.g. product prototype, technical specification (“spec”) that lists the product’s features

 

doc plan을 공유하면 좋은 점?

문서 이해관계자들이 스케줄에 맞춰 문서를 만들어내기 위해 각자 무엇을, 언제까지 해야하는지 이해할 수 있음

 

What’s a doc plan?

doc plan은 콘텐츠 개발 프로젝트의 모든 구성요소를 다 서술함

doc plan은 다음 정보를 포함해야 함

Product description

• a brief summary of what the product does
• 1~2 문장으로 이 제품이 어떤 역할을 하는지 간단하게 요약

Audience

• characteristics of the product’s users
• 각 사용자 유형에 관해 제공할 수 있는 모든 정보를 제공해야 함
  • education level
  • demographic information
  • level of technological expertise
  • the features (that each type of user will use)
• audience에 대해 알면 알수록, 그들의 요구사항을 충족할 콘텐츠를 쓸 수 있다

Deliverables

• the names of the documents you will create
• a brief description of each
• how they will be delivered
  • printed manuals
  • online help
  • HTML

Receivables

• what the writers and other documentation team members need from others
  • the latest version of the product
  • acess to the developers to get questions answered
  • existing content
  • a template

Style

• what style guidelines will be followed
• e.g. Microsoft Style Guide

Tasks

• list of the actions required to complete the project
• who is responsible for them
  • documentation team
    • handle information gathering
    • writing
    • editing
    • production editing
    • indexing
  • product developers
    • provide technical assistance
    • ensure the accuracy of content

Tools

• what tools the documentation team will use to create the content

Schedules

• a schedule for each deliverable
• include
  • dates for editing
  • illustration
  • indexing
  • preparation for final output
    • print
    • online
    • or both

 

Any formulas for writing doc plans?

doc plan에는 페이지 분량이라든지 스케줄 등이 포함돼야 함

 

reasonable estimates are as follows:

• 8 hours per completed page
• 8 hours per online help topic
• 40 hours per one hour of instruction time

 

A “completed” page includes all components of the writing process:

• Writing
• Editing
• Indexing
• Template design and document formatting
• Production

 

53p 🤔

page 분량을 계산하기 위해서, 유저가 수행하는 각각의 태스크가 약 2 page 정도의 콘텐츠가 필요하다 추정해보고

그럼 문서 작성을 위해서 몇 개의 task를 써야 하는지와 앞단과 뒷단의 문제들을 위한 여분의 페이지를 덧붙여라

 

프로젝트를 마치고

만약 예상 소요 시간이 실제 소요 시간과 차이가 난다면, 그 차이가 무엇 때문에 생긴건지 파악해야 함

이 과정을 반복할수록 예상 소요 시간을 좀 더 정확하게 측정할 수 있을거임

 

물론 제품의 난이도가 변경 사항이 많으면 시간이 더 소요될 수 있으니 이 점도 고려를 해야함.

 

Outlining이 필요한 이유

1. 분량이 많아질수록 내용을 다 머릿속에 담기 힘듦
2. 한 번에 한 섹션에 집중할 수 있음

 

What goes into the outline?

• 사용자가 제품을 사용하면서 어떤 task를 마쳐야 하는지 파악해야 함
• 내가 new user라고 생각하고 해당 task를 마치려면 step-by-step 무엇을 해야할지를 파악해야 함
• a list of tasks 구성 & organize them into an outline

 

outline sources

• the prototype
• review the spec
• product design documents
• marketing plans
• business plans
• interface design documents
• user content for related product
  • 비슷한 서비스 제품 살펴보면 내가 작성할 문서에 어떤 정보들을 담아야 할지 아이디어를 얻을 수 있음

 

Writing the outline

outline은 꼭 formal할 필요는 없음

자기한테 맞는 방식으로 쓰면 됨

다만, be sure to get the outlines approved

why? 매니저나 다른 시니어 라이터가 내가 놓친 부분을 인지하도록 도와줄 수 있음

 

출처: Technical Writing 101