AgentSkillsCN

Documentation Structure

按照最佳实践组织项目文档。适用于设置项目文档、重新组织文档或用户说“文档结构”时使用。提供标准模板和组织方式。

SKILL.md
--- frontmatter
name: Documentation Structure
description: Organize project documentation following best practices. Use when setting up project docs, reorganizing documentation, or user says "documentation structure". Provides standard templates and organization.
allowed-tools: Read, Write, Glob
version: 1.0.0

Documentation Structure

Purpose

Provide standardized documentation organization and templates for projects.

When This Activates

  • •User says "documentation structure", "organize docs"
  • •New project setup
  • •Documentation reorganization needed

Steps

Step 1: Analyze Current Documentation

Scan project for existing docs

Step 2: Propose Structure

Suggest standard documentation organization:

  • •README.md
  • •CONTRIBUTING.md
  • •CHANGELOG.md
  • •docs/ directory structure

Step 3: Create Templates

Provide templates for each documentation type

Step 4: Implement Structure

Create directories and template files (if approved)

Standard Structure

code
Documentation/
├── README.md
├── CONTRIBUTING.md
├── CHANGELOG.md
├── General/
├── Technical/
├── API/
└── Deployment/

Changelog

Version 1.0.0 (2025-10-20)

  • •Initial release

End of Skill