Claude Code Documentation Templates for a Working README
Organize a README around the project's purpose, quick start, configuration, and links to deeper documentation. Use real startup steps that a new contributor can verify.
中文Install in Claude Code
Use Claude Code with the pinned skill directory. Bring actual startup instructions, shareable sample configuration, and documentation paths.
- Get the complete `cli-tool/components/skills/document-processing/documentation-templates` directory from the pinned GitHub checkout.
- Copy it under the target project's `.claude/skills/`. Confirm `.claude/skills/documentation-templates/SKILL.md`, open Claude Code at the project root, and call `/documentation-templates`.
Example task
Write a README for a fictional CSV cleanup tool. It reads `sample.csv`, repairs blank column names, and writes `clean.csv`. Use the supplied run procedure and tell readers how to check the output.What to check
Expect a project summary, sample input, verified setup steps, and an observable output file. Link detailed field rules from the relevant documentation section.
Original SKILL.md on GitHub · Updated
Frequently asked question
Does a quick start need to include every configuration option?
Include the settings and defaults needed for the first example. Put the remaining options in the configuration section or deeper documentation.