docs-writer
Write or update READMEs, PR notes, and implementation docs for technical projects.
Install
mkdir -p .claude/skills/docs-writer-kounishiyuuki && curl -L -o skill.zip "https://agentskills.codes/api/skills/download/13100" && unzip -o skill.zip -d .claude/skills/docs-writer-kounishiyuuki && rm skill.zipInstalls to .claude/skills/docs-writer-kounishiyuuki
Activation
This is the description your AI agent reads to decide when to run this skill — the better it matches your request, the more reliably it fires.
Use this skill when Codex needs to create or update practical documentation for a frontend, mobile, or portfolio project.Key capabilities
- →Write README sections and implementation notes
- →Create PR descriptions and release notes
- →Generate demo scripts and presentation explanations
- →Gather facts from code and commands
- →Include concrete commands from `package.json`
- →Separate summary, verification, and risks in PR text
How it works
The skill reads relevant files and commands, identifies the audience and document type, then writes documentation in a compact structure including context, changes, verification, risks, and follow-ups.
Inputs & outputs
When to use docs-writer
- →Writing PR descriptions
- →Updating README implementation notes
- →Creating release checklists
About this skill
Docs Writer Skill
Use this skill when Codex needs to create or update practical documentation for a frontend, mobile, or portfolio project.
Purpose
- Write clear README sections, implementation notes, PR descriptions, release notes, demo scripts, and presentation explanations.
- Explain what changed, why it changed, how to verify it, and what risks remain.
- Keep documentation accurate to the repository instead of generic or promotional.
When To Use
- The user asks for README updates, docs, implementation notes, PR text, changelog, release notes, demo explanations, or presentation copy.
- A feature, UI polish pass, test setup, workflow setup, or refactor needs a human-readable summary.
- Reviewers need reproduction steps, verification commands, screenshots, or merge notes.
- A portfolio page or project needs concise technical explanation.
Workflow
- Read
AGENTS.mdand inspect the target files, current diff, or feature behavior. - Identify the audience:
- Future maintainer.
- PR reviewer.
- Portfolio viewer.
- Demo/presentation audience.
- Yourself/Codex in future workflows.
- Choose the document type:
- README section.
- Implementation memo.
- PR description.
- Release checklist.
- Demo script.
- Portfolio project explanation.
- Gather facts from code and commands. Do not invent architecture, dependencies, metrics, or external integrations.
- Write in a compact structure:
- Context.
- What changed or exists.
- How to run or verify.
- Risks, limits, or follow-ups.
- Include concrete commands from
package.jsonwhen relevant:npm run lintnpm run typechecknpm run testnpm run build
- For PR/release docs, include testing status and remaining risks.
- For presentation/demo docs, include what to show on screen and a short viewer-friendly explanation.
- If editing files, only edit requested documentation files. Do not modify application code.
Checklist
- The doc matches the current repo structure and scripts.
- Claims are backed by files, code, or command output.
- Setup steps are minimal and reproducible.
- Verification commands are included when useful.
- Limitations and follow-ups are honest.
- PR text separates summary, verification, and risks.
- Demo text includes scenario, prompts/commands, expected behavior, and recovery steps.
- Portfolio explanations are clear, concrete, and not inflated.
Constraints
- Do not add dependencies.
- Do not modify application code.
- Do not document features that do not exist.
- Do not paste secrets, private URLs, or sensitive personal data.
- Do not over-document obvious code; keep docs practical and maintainable.
- Preserve existing README tone and structure when updating existing docs.
- Ask before replacing large existing documentation unless the user explicitly requested a rewrite.
Final Output Format
Use this format:
Docs updated for <topic>.
Created/updated:
- <file>
Included:
- <setup, usage, verification, PR notes, demo notes, or risks>
Verification:
- `<command>` passed
- `<command>` not run: docs-only change
Notes:
- <follow-up or "None">
For generated text without file edits:
Draft:
<ready-to-use documentation text>
Sources checked:
- <file or command>
Notes:
- <assumption or "None">
When not to use it
- →When documenting features that do not exist
- →When modifying application code
- →When adding dependencies
Limitations
- →Does not add dependencies
- →Does not modify application code
- →Does not document features that do not exist
How it compares
This skill generates structured, project-specific documentation based on code and commands, rather than relying on generic or manually written explanations.
Compared to similar skills
docs-writer side by side with the closest alternatives in the catalog.
| Skill | Installs | Updated | Safety | Difficulty |
|---|---|---|---|---|
| docs-writer (this skill) | 0 | 3mo | No flags | Intermediate |
| docs-write | 22 | 6mo | No flags | Beginner |
| content-research-writer | 15 | 10mo | No flags | Beginner |
| doc-coauthoring | 16 | 8mo | No flags | Beginner |
Try saying
Example prompts that trigger this skill in your AI assistant.
You might also like
docs-write
metabase
Write documentation following Metabase's conversational, clear, and user-focused style. Use when creating or editing documentation files (markdown, MDX, etc.).
content-research-writer
ComposioHQ
Assists in writing high-quality content by conducting research, adding citations, improving hooks, iterating on outlines, and providing real-time feedback on each section. Transforms your writing process from solo effort to collaborative partnership.
doc-coauthoring
anthropics
Guide users through a structured workflow for co-authoring documentation. Use when user wants to write documentation, proposals, technical specs, decision docs, or similar structured content. This workflow helps users efficiently transfer context, refine content through iteration, and verify the doc works for readers. Trigger when user mentions writing docs, creating proposals, drafting specs, or similar documentation tasks.
research-grants
davila7
Write competitive research proposals for NSF, NIH, DOE, and DARPA. Agency-specific formatting, review criteria, budget preparation, broader impacts, significance statements, innovation narratives, and compliance with submission requirements.
teams-channel-post-writer
daymade
Creates educational Teams channel posts for internal knowledge sharing about Claude Code features, tools, and best practices. Applies when writing posts, announcements, or documentation to teach colleagues effective Claude Code usage, announce new features, share productivity tips, or document lessons learned. Provides templates, writing guidelines, and structured approaches emphasizing concrete examples, underlying principles, and connections to best practices like context engineering. Activates for content involving Teams posts, channel announcements, feature documentation, or tip sharing.
write-docs
tldraw
Writing SDK documentation for tldraw. Use when creating new documentation articles, updating existing docs, or when documentation writing guidance is needed. Applies to docs in apps/docs/content/.