제품 설명서
사용자가 애플리케이션에서 지원하는 작업을 완료할 수 있도록 도와주세요.
사용자에게 애플리케이션의 사용 방법을 설명하고 작업을 완료하는 데 도움이 되는 실용적인 가이드를 제공합니다.
제품 기능을 실용적인 지침으로 변환
- 가이드 스코프를 준비합니다.
문서 섹션과 해당 섹션의 대상 독자를 검토하십시오.
- 콘텐츠 질문에 답변하세요.
가이드에서 설명해야 할 워크플로우와 정보를 명확히 설명하세요.
- 공지사항을 따르세요.
빌드 진행 상황과 문서 사이트 주소를 확인하세요.
애플리케이션 사용 방법을 설명하세요.
문서는 제품 소개를 보완하여 실용적인 지침을 제공합니다. 먼저 시작하는 방법부터 안내하고, 그런 다음 사용자가 애플리케이션에서 실제로 사용할 수 있는 작업 흐름을 안내합니다.
문서 구성은 섹션 정의 및 질문을 제공합니다. 사용자의 언어로 작업을 설명하는 데 도움이 되는 맥락을 제공하세요.
가이드를 실행 중인 애플리케이션에 연결된 상태로 유지하세요.
처음으로 유용한 작업을 지원합니다.. 제품 사용 시작 가이드는 신규 사용자에게 제품을 쉽게 사용할 수 있도록 안내합니다. 시작하는 방법, 필요한 정보, 작업이 완료되었는지 확인하는 방법을 설명해야 합니다.
반복되는 워크플로우를 설명합니다.. 자세한 안내는 실제 애플리케이션 레이블과 단계를 따릅니다. 필수 조건, 번호가 매겨진 단계 및 예상 결과는 사용자가 화면에 대한 일반적인 설명을 해석하지 않고 비즈니스 작업을 반복하는 데 도움이 됩니다.
일반적인 질문에 답변. 일부 질문은 특정 화면보다는 계정, 비용 또는 게시물과 관련이 있습니다. FAQ는 간결한 답변과 관련 가이드 링크를 제공하여 절차를 한 곳에 모아 웹사이트 전체에 걸쳐 중복되는 것을 방지합니다.
제품과 가이드를 연결된 상태로 유지하세요.
유의미한 애플리케이션 변경 후 문서를 검토하세요. 가이드에는 사용자가 실제로 볼 수 있는 레이블과 동작을 사용해야 합니다.
문서는 자체 공개 서비스에서 실행됩니다. 웹사이트에서 연결하고 프로젝트에서 게시하는 언어로 된 가이드를 확인하십시오.
사용자가 다음 작업을 완료하도록 도와주세요.
이 실용적인 가이드에서는 어디서부터 시작해야 하는지, 필요한 정보는 무엇인지, 결과를 어떻게 확인해야 하는지 설명합니다. 이 가이드의 가치는 독자가 애플리케이션에서 실제로 작업을 수행할 수 있도록 돕는 데 있습니다.
여러 영역에 걸쳐 작업이 진행될 경우 관련 가이드를 참고하여 계속 진행합니다. 화면이 변경될 때마다 문서를 검토하여 진화 후에도 지침이 유용하도록 합니다.
합의된 기능에서 유용한 도움으로
가이드 스코프 준비. 문서 섹션과 해당 섹션이 설명해야 하는 작업을 검토하십시오. 대상 사용자 및 애플리케이션 동작을 명확하게 유지하십시오.
누락된 문맥을 입력하세요.. 필수 조건, 규칙 및 결과에 대한 질문에 답변합니다. 실제 인터페이스를 사용하고 가상의 컨트롤은 사용하지 않도록 작성합니다.
게시 후 검토 및 수정. 앱 내 가이드에 따라 언어와 관련 링크를 확인한 다음, 기본 작업이 변경되면 다시 확인하세요.
제품 설명서 관련 질문
기능 페이지는 잠재 고객이 기능과 그 가치를 이해하는 데 도움이 됩니다. 가이드는 사용자가 실제 컨트롤, 전제 조건 및 결과를 통해 작업을 수행하는 데 도움이 됩니다. 이 두 가지는 서로 보완적입니다.
문서 작성 도구를 통해 섹션 정의와 질문을 확인합니다. 애플리케이션에서 지원하는 작업을 검토하고, 필요한 정보를 추가하고, 작성 진행 상황을 따릅니다.
이 프로젝트는 해당 범위에 대한 현지화된 가이드를 게시합니다. 게시된 각 언어를 검토하여 전체 절차와 올바른 인터페이스 레이블이 유지되도록 합니다.
작업, 해당 작업의 컨트롤 또는 예상 결과에 영향을 미치는 변경 사항이 있는 경우, 원래 지침이 유효하다고 가정하는 대신 작동 중인 애플리케이션을 기준으로 텍스트를 확인하세요.
엔드포인트 참조는 활성 상태의 작동 중인 API가 있는 프로젝트에 속합니다. 실제 운영 및 참조를 사용하십시오. 계획된 경로는 사용 가능한 통합을 문서화하기에 충분하지 않습니다.