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?" |

遵循八项规则和 Diataxis 框架编写清晰、可发现的软件文档。在创建自述文件、API 文档、教程、操作指南或任何项目文档时使用。自动强制执行文档/位置、链接要求和可运行示例。 来源：nilecui/skillsbase。

查看原文