Agent skill
create-project-docs
Creates comprehensive GitHub project documentation including README, CONTRIBUTING, CODE_OF_CONDUCT, CHANGELOG, architecture docs, and API documentation. Analyzes codebase to generate accurate, well-styled documentation with modern GitHub aesthetics. Use when setting up a new project, improving existing documentation, or generating missing docs.
Install this agent skill to your Project
npx add-skill https://github.com/majiayu000/claude-skill-registry/tree/main/skills/documents/create-project-docs
SKILL.md
<essential_principles>
</essential_principles>
- Generate full documentation suite - README, CONTRIBUTING, CODE_OF_CONDUCT, CHANGELOG, architecture, API docs
- Generate a single document - Create or replace one specific document
- Update existing documentation - Refresh docs based on code changes
- Audit documentation - Check what's missing or outdated
Wait for response before proceeding.
After reading the workflow, follow it exactly.
<reference_index>
All domain knowledge in references/:
Styling: github-styling.md (badges, emoji, collapsible sections, modern conventions) Document Types: doc-types.md (what each document should contain, best practices) Code Analysis: code-analysis.md (how to extract info from source files) </reference_index>
<template_index>
Output templates in templates/:
| Template | Purpose |
|---|---|
| readme-template.md | Modern README with all sections |
| contributing-template.md | Contribution guidelines |
| code-of-conduct-template.md | Community standards |
| changelog-template.md | Version history format |
| architecture-template.md | System design documentation |
| api-docs-template.md | API reference format |
| </template_index> |
<workflows_index>
| Workflow | Purpose |
|---|---|
| generate-full-suite.md | Create complete documentation set |
| generate-single-doc.md | Create one specific document |
| update-docs.md | Refresh existing docs from code |
| audit-docs.md | Check documentation completeness |
| </workflows_index> |
<success_criteria> Documentation is complete when:
- All generated docs accurately reflect the codebase
- README provides working quick-start example
- Installation instructions are tested
- API documentation covers all public interfaces
- Styling is consistent across all documents
- Links between documents work correctly </success_criteria>
Recommended Agent Skills
Expand your agent's capabilities with these related and highly-rated skills.
majiayu000/claude-skill-registry
agent-ops-spec
Manage specification documents in .agent/specs/. Use when user provides requirements, acceptance criteria, or feature descriptions that need to be tracked and validated against implementation.
majiayu000/claude-skill-registry
agent-ops-state
Maintain .agent state files. Use at session start, after meaningful steps, and before concluding: read/update constitution/memory/focus/issues/baseline consistently.
majiayu000/claude-skill-registry
agent-ops-spec
Manage specification documents in .agent/specs/. Use when user provides requirements, acceptance criteria, or feature descriptions that need to be tracked and validated against implementation.
majiayu000/claude-skill-registry
agent-ops-testing
Test strategy, execution, and coverage analysis. Use when designing tests, running test suites, or analyzing test results beyond baseline checks.
majiayu000/claude-skill-registry
agent-ops-testing
Test strategy, execution, and coverage analysis. Use when designing tests, running test suites, or analyzing test results beyond baseline checks.
majiayu000/claude-skill-registry
agent-ops-state
Maintain .agent state files. Use at session start, after meaningful steps, and before concluding: read/update constitution/memory/focus/issues/baseline consistently.
Didn't find tool you were looking for?