docs-refactor
1
总安装量
1
周安装量
#43334
全站排名
安装命令
npx skills add https://github.com/luongnv89/skills --skill docs-refactor
Agent 安装分布
openclaw
1
opencode
1
codex
1
claude-code
1
Skill 文档
Workflow
1. Analyze Project
Identify:
- Project type: Library, API, web app, CLI, microservices
- Architecture: Monorepo, multi-package, single module
- User personas: End users, developers, operators
2. Restructure Documentation
Root README.md – Streamline as entry point:
- Project overview and purpose
- Quickstart (install + first use)
- Modules/components summary with links
- License and contacts
Component READMEs – Add per module/package/service:
- Purpose and responsibilities
- Setup instructions
- Testing commands
Centralize in docs/ – Organize by category (select applicable):
docs/
âââ architecture.md # System design, diagrams
âââ api-reference.md # Endpoints, authentication
âââ database.md # Schema, migrations
âââ deployment.md # Production setup
âââ development.md # Local setup, contribution
âââ troubleshooting.md # Common issues
âââ user-guide.md # End-user documentation
3. Create Diagrams
Use Mermaid for all visual documentation:
- Architecture diagrams
- Data flow diagrams
- Database schemas
Guidelines
- Keep docs concise and scannable
- Adapt structure to project type (not all categories apply)
- Maintain cross-references between related docs
- Remove redundant or outdated content