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 ドキュメント、チュートリアル、ハウツー ガイド、またはプロジェクト ドキュメントを作成するときに使用します。ドキュメント/場所、リンク要件、および実行可能なサンプルを自動的に適用します。 ソース: nilecui/skillsbase。

原文を見る