Documentation:ManualGuidelines

일반 매뉴얼 작성 가이드라인

적용할 규칙들

• 애매하거나 해석의 여지가 있거나 수치화/정형화 할 수 없는 문장은 사용 금지.
• 결과물에 대한 조건을 반드시 문서로 명시화 하고 관계자들은 모두 동일하게 공유한다.
• 결과물 완성 일정은 반드시 존재해야 한다.
  • 사원 및 주임 연차는은 일정의 절반이 지나가기 전에 방향성 및 중간 결과물을 보여줘야 한다.
    • 단 일정이 2일 이상일 경우만
• 일정은 반드시 준수해야 한다.
  • "일정을 준수했다"는 일정까지 진행된 작업물을 공유 했다가 아니라 "협의된 결과물이 완성 되었다" 이다.
• 결과 발표 전에 결과 파일은 메일로 전송해야 한다.
  • 메일로 전송할 결과물은 LINK 이면 안된다. 오프라인 환경에서 볼 수 있는 파일이여야 한다. (최소한 PDF)
  • 받는 사람이 외부 발송 이거나 관리자급 이상일 경우 첨부파일은 항상 "[원본문서] + [PDF]" 으로 첨부 한다.
• 메일로 결과를 전송한 후 "구두 보고하러 온다".
• 템플릿이 있다면 사용하자.
• 템플릿이 없다면 가장 유사한 템플릿을 검색하여 샘플로 제시해야 한다.
• 문서 본문 컨텐츠에 "있다/없다" 같은 열거형 값은 이모지(✅,⚠️,❌) 따위를 사용하여 한눈에 판단할 수 있도록 정리한다.

See also

• Documentation