AgentSkillsCN

documentation-refactor

重构项目文档,提升清晰度与可访问性

SKILL.md
--- frontmatter
name: documentation-refactor
description: Restructure project documentation for clarity and accessibility
tags: documentation, refactoring, organization

Documentation Refactor

Refactor project documentation structure adapted to project type: 1. Analyze project : Identify type (library/API/web app/CLI/microservices), architecture, and user personas 2. Centralize docs : Move technical documentation to docs/ with proper cross-references 3. Root README.md : Streamline as entry point with overview, quickstart, modules/components summary, license, contacts 4. Component docs : Add module/package/service-level README files with setup and testing instructions 5. Organize docs/ by relevant categories:

  • Architecture, API Reference, Database, Design, Troubleshooting, Deployment, Contributing (adapt to project needs)

Create guides (select applicable):

  • User Guide: End-user documentation for applications
  • API Documentation: Endpoints, authentication, examples for APIs
  • Development Guide: Setup, testing, contribution workflow
  • Deployment Guide: Production deployment for services/apps

Use Mermaid for all diagrams (architecture, flows, schemas) Keep docs concise, scannable, and contextual to project type.