Claude Code docs-writer for open-source workflow onboarding
Document the entry point, configuration, collaboration roles, and verified troubleshooting advice in a README and separate guides.
中文Install in Claude Code
Open an Agentic PRD Workflow or similarly organized project in Claude Code. Have verified commands and expected outputs.
- Review `.claude/skills/docs-writer/SKILL.md` and its requirements at the pinned GitHub commit.
- Create `.claude/skills/docs-writer/` in your project and save the reviewed file as `.claude/skills/docs-writer/SKILL.md`.
- Start Claude Code from that project's root, then select `/docs-writer` in the slash menu.
Example task
The guide-17 sample records “tool check --sample” with successful output “Sample configuration is valid”. A known error occurs when its sample configuration is loaded outside the project root.What to check
Keep [tool check --sample, Sample configuration is valid] in the quick start and point to project setup as the next step. Include retrying from the project root in troubleshooting.
Original SKILL.md on GitHub · Updated
Frequently asked question
Should the README contain all configuration details and team roles?
Use the README to explain the project and shortest successful path. Link to separate documents for detailed design and collaboration roles.