실천해야 할 설명서 표준

따르는 표준은 만드는 설명서 유형에 따라 다릅니다. 다음은 몇 가지 일반적인 유형 및 표준을 수립할 때 사용할 수 있는 템플릿에 대한 제안입니다.

모든 관계자가 같은 정보를 공유하고 있으면 프로젝트가 더 원활하게 진행됩니다. 프로젝트의 모든 팀원은 언제든지 참조할 수 있는 단일 정보 소스가 필요합니다. 문서화된 프로젝트 계획이 없으면 팀원은 큰 그림을 보지 못하고 시간만 낭비할 수 있습니다.

프로젝트 설명서의 속도를 높이고 표준화하기 위해 이 Confluence의 템플릿을 사용할 수 있습니다. 모든 프로젝트에 대한 주요 정보를 일관성 있게 캡처할 수 있습니다.

팀원이 다른 팀원에게 어떻게 해야 하는지 끊임없이 설명하는 데 시간을 낭비하고 있습니까? 핵심 작업 또는 프로세스를 수행하는 방법을 아는 직원이 부재중일 때 허둥지둥한 적이 있습니까?

이 시나리오는 방법 안내 설명서의 중요성을 나타냅니다. 기본적으로 팀원이 반복해서 수행하는 모든 작업은 모든 팀원이 해당 작업 또는 프로세스를 완료할 수 있는 방식으로 문서화해야 합니다.

표준을 수립하면 방법 안내 설명서를 더 쉽게 만들 수 있을 뿐만 아니라 더 효과적입니다. 그래서 이때 템플릿이 필요합니다. 예를 들어 방법 안내 문서에 대한 Confluence의 템플릿은 프로세스 설명서의 기준을 제공합니다.

소프트웨어 및 기타 기술 제품의 설명서에는 제품의 작동 방식, 사용 방법, 개발 프로세스 및 구성 방식이 포함될 수 있습니다.

소프트웨어 팀은 제품 요구 사항, 릴리스 정보 또는 디자인 사양에 대해 이야기할 때 설명서를 참조할 수 있습니다. 기술 팀은 설명서를 사용하여 코드 및 API를 자세히 설명하고 소프트웨어 개발 프로세스를 기록할 수 있습니다.

기술 설명서는 내용이 많고 상세하며 자주 업데이트되는 경향이 있으므로 정확성을 보장하고 시간을 절약할 수 있는 적절한 도구를 갖추는 것이 특히 중요합니다. 예를 들어 Confluence의 기존 템플릿을 사용하거나 직접 템플릿을 만들 수 있습니다. Confluence에는 매크로가 있어서 텍스트를 쉽게 업데이트하거나 다시 사용할 수도 있습니다.

작성 중인 설명서 유형과 관계없이 작업이 설명서 표준을 충족하고 사용자에게 도움이 되는 몇 가지 주요 기술이 있습니다.

• 체계화. 문서화할 정보를 아는 것도 한 가지 기술입니다. 따라하기 쉬운 방식으로 제시하는 것은 전혀 다른 일입니다. 정보를 논리적인 순서로 체계화하는 것 외에도 섹션 머리글 및 글머리 기호 목록와 같은 요소를 사용하여 사용자에게 설명서를 안내하는 것도 중요합니다.
• 명료. 명확하고 이해하기 쉬운 설명서를 위해 세부 사항 수준을 적절하게 선택해야 합니다. 정보가 너무 적어도 혼란스럽지만 너무 많아도 그렇습니다. 문법을 꼼꼼하게 확인하고 전문 용어 사용을 피하고 모호한 표현(예:" 자주")보다 구체적인 표현을 선택하는 것도 설명서를 더 명료하게 만드는 방법입니다.
• 일관성. 일관성에 주의를 기울이는 것은 설명서를 사용하는 모든 사용자를 위해 할 수 있는 가장 유용한 작업입니다. 예를 들어 조직의 다른 방법 안내 설명서와 동일한 방식으로 작성된 경우 사용자는 방법 안내 설명서를 더 쉽게 따라갈 수 있습니다.

표준을 수립하면 더 나은 설명서를 만들 수 있을 뿐만 아니라 설명서를 더 효과적으로 배포할 수 있습니다.

전체 팀이 설명서에 액세스할 수 있어야 유용한 설명서입니다. 개인 하드 드라이브에 팀원이 중요한 정보를 보관하는 것을 원하지 않을 것입니다. 또한 팀원이 무작위 파일 캐비닛에 숨겨져 있는 단일 인쇄본에 의존해야 하는 상황을 원하지 않을 것입니다. 이런 상황은 혼란을 야기하고 비효율적입니다.

예를 들어 팀원들이 서로 다른 버전의 설명서를 사용하면 커뮤니케이션에 착오가 생기거나 실수로 서로에게 추가 작업을 만들어 줄 수 있습니다. 또는 원격으로 작업 중인 직원이 사무실에 물리적 사본으로만 존재하는 설명서에 액세스해야 할 수도 있습니다.

설명서를 저장하고 배포하는 방법을 표준화하여 이 문제를 방지할 수 있습니다. 모든 사용자가 최신 정보를 찾을 수 있는 단일 장소인 중앙 집중식 리포지토리를 사용하는 것이 가장 좋습니다. 그러나 모든 것을 한곳에 모으는 것뿐만 아니라 사용자가 그 장소에서 원하는 것을 쉽게 찾을 수 있도록 해야 합니다.

Atlassian에서 중앙 집중식 리포지토리는 바로 Confluence입니다. 강력한 검색 기능과 체계적으로 정리된 페이지 트리, 페이지 보관과 같은 기능을 통해 콘텐츠를 쉽게 찾고 액세스하며 최신 상태로 관리할 수 있습니다.

Confluence에는 모든 팀 또는 프로젝트에 관련된 설명서를 체계화할 공간이 있습니다. 페이지 트리에서 모든 정보를 체계화하고 볼 수 있도록 페이지 계층 구조를 만들 수 있습니다. 직원은 콘텐츠에 변경 사항이 있을 때 업데이트를 받을 수 있도록 관심 있는 스페이스 또는 하위 페이지를 관찰할 수 있습니다. 특정 스페이스 또는 페이지를 배포하려면 공유 버튼을 사용하거나 페이지에 댓글을 추가하고 다른 팀원에 태그를 지정할 수 있습니다. Confluence에 열려 있는 모든 페이지는 다른 직원이 검색할 수 있으며 필터를 사용하여 작성자, 게시 날짜 또는 스페이스별로 검색 범위를 좁힐 수 있습니다.

개별 설명서를 일관성 있게 업데이트해야 하는 것처럼 설명서를 파일화 및 체계화하는 시스템도 필요합니다. 여기서도 표준을 수립하는 것을 잊지 마세요. 문서 파일화를 얼마나 자주 다시 검토하고 정리해야 합니까? 캘린더를 확인하여 시간을 따로 확보해 두세요.

설명서 표준을 간략하게 살펴봤으므로 이제 팀에 필요한 설명서 유형에 관한 가이드라인을 개발하거나 수정할 수 있습니다. 표준을 설정하는 데 시간을 투자하면 설명서를 더 빠르게 만들고 팀은 설명서를 더 유용하게 사용할 수 있습니다.