What problem does it solve? Project documentation often fails because tutorials and reference material get mixed together, READMEs grow without bound, and docs drift out of sync with the code. This Skill provides a decision framework for classifying, placing, structuring, and maintaining project documentation in Chinese. ## Core Features & Use Cases - Tutorial vs. Reference Classification: Decide whether a document should be a sequential tutorial with verifiable steps or a randomly accessible reference organized by topic. - Placement and Structure Rules: Keep each README scoped to its own module, push details down to the layer that owns them, and structure READMEs so the first screen answers relevance and the second gets users running. - Writing and Maintenance Guidelines: Write verifiable step-by-step tutorials, self-contained reference entries, meaningful code comments, and keep docs synchronized with code changes in the same commit. - Use Case: When asked to write a README for a new module, the Skill first determines the audience's reading mode, then produces a structure with a one-line summary, quick start, common usage scenarios, and links to deeper docs. ## Quick Start Use the write-docs-cn skill to write a README for my new module, deciding first whether it should be a tutorial or a reference document.
