documentation-writing

SKILL.md

Creates high-quality, discoverable documentation following the Eight Rules and Diataxis framework. Ensures all docs are properly located, linked, and contain real runnable examples.

| Type | Purpose | Location | User Question |

| Tutorial | Learning | docs/tutorials/ | "Teach me how" | | How-To | Doing | docs/howto/ | "Help me do X" | | Reference | Information | docs/reference/ | "What are the options?" | | Explanation | Understanding | docs/concepts/ | "Why is it this way?" |

Eight Rules 및 Diataxis 프레임워크에 따라 명확하고 검색 가능한 소프트웨어 문서를 작성합니다. README 파일, API 문서, 튜토리얼, 방법 가이드 또는 프로젝트 문서를 생성할 때 사용합니다. 문서/위치, 연결 요구 사항 및 실행 가능한 예제를 자동으로 적용합니다. 출처: rysweet/amplihack.

원본 보기