Automated workflow for building, reviewing, and compressing project documentation.
Install
mkdir -p .claude/skills/docs-joeharris76 && curl -L -o skill.zip "https://agentskills.codes/api/skills/download/18229" && unzip -o skill.zip -d .claude/skills/docs-joeharris76 && rm skill.zipInstalls to .claude/skills/docs-joeharris76
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 when the user asks to "create documentation", "build docs", "review docs", "compare documents", "compress docs", "adversarial review docs", or "commit docs".Key capabilities
- →Create new documentation pages in configured locations
- →Build and validate documentation using configured commands
- →Review documentation for accuracy, completeness, and clarity
- →Compare documents using a comparison framework
- →Compress documentation while preserving executable constraints
How it works
The skill reads configuration to perform various documentation tasks like creation, building, reviewing, comparing, and compressing. It ensures validation and adherence to hard rules for each action.
Inputs & outputs
When to use docs
- →Create new doc page
- →Review documentation
- →Compress docs
- →Validate doc build
About this skill
Docs Workflow
Route the request to one action below. Before acting, read the file in the Read column for the selected action. Preserve local markup, navigation, and build conventions.
Resolve
Read .claude/skills/skill-sync.config.yaml docs first for builder, source
directory, build/serve/linkcheck/validate commands, markup, doc locations, and
personas. Fall back to repo docs config and the Makefile.
Actions
| Action | Trigger | Read |
|---|---|---|
create | create/add documentation | references/create.md |
build | build/validate docs | references/build.md |
review | review/check docs | references/review.md |
compare | compare documents | SHARED/compare-framework/SKILL.md |
shrink | compress/shrink docs | SHARED/shrink-framework/SKILL.md |
adversarial | adversarial/user-perspective review | references/adversarial.md |
commit | commit documentation | references/commit.md |
help | help/list actions | this table |
Global rules
review,adversarial, andcompareare read-only underSHARED/review-protocol/SKILL.md.- Write actions verify with configured build/validate commands before commit.
- Shrink preserves frontmatter, commands, paths, thresholds, relationships, decisions, and public contracts.
- Do not compress READMEs, changelogs, decisions, generated docs, or study artifacts unless explicitly requested.
When not to use it
- →When the user wants to perform write actions without verification
- →When the user wants to compress READMEs, changelogs, or generated docs without explicit request
- →When the user wants to ignore the read-only nature of review, adversarial, and compare actions
Limitations
- →Review, adversarial, and compare actions are read-only
- →Write actions verify with configured build/validate command before commit
- →Shrink must preserve frontmatter, commands, paths, thresholds, relationships, decisions, and public contracts
How it compares
This skill provides a structured and automated workflow for managing documentation, including specialized review and comparison capabilities, which is more complete than manual document handling.
Compared to similar skills
docs side by side with the closest alternatives in the catalog.
| Skill | Installs | Updated | Safety | Difficulty |
|---|---|---|---|---|
| docs (this skill) | 0 | 29d | No flags | Intermediate |
| docs-write | 22 | 5mo | No flags | Beginner |
| content-research-writer | 15 | 9mo | No flags | Beginner |
| doc-coauthoring | 16 | 7mo | No flags | Beginner |
Try saying
Example prompts that trigger this skill in your AI assistant.
More by joeharris76
View all by joeharris76 →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/.