AgentSkillsCN

documentation

以简洁而高效的文档记录方式，维护项目文档。

SKILL.md
--- frontmatter
name: documentation
description: Documentation skill for maintaining simple, effective project documentation
license: MIT
compatibility: opencode
metadata:
  audience: developers
  workflow: docs

Documentation Skill

Core Principles

  • •Keep documentation SIMPLE
  • •One README.md file at root level
  • •No extensive documentation files
  • •Update README after every significant change

README.md Structure

The root README must contain:

  1. •Project title and brief description
  2. •Tech stack overview
  3. •Setup instructions
  4. •Environment variables required
  5. •Available commands/scripts
  6. •Recent changes/updates

When to Create Additional Docs

Only create additional markdown files if:

  • •Absolutely essential for the project
  • •Cannot fit reasonably in README.md
  • •Explicitly requested by user

If additional docs are needed:

  • •Place them in docs/ folder at root
  • •Keep them minimal and focused
  • •Reference them from README.md

Bug Fix Documentation

Every bug fix must be documented:

  1. •What was the error/issue
  2. •What caused it
  3. •How it was fixed
  4. •When it was fixed

Why this matters:

  • •Useful if the bug appears again in future
  • •Helps team members understand changes
  • •Creates a knowledge base for common issues

Update Protocol

After every significant change:

  1. •Update README.md with new information
  2. •Document any new dependencies
  3. •Update setup instructions if needed
  4. •Add any new environment variables
  5. •Note any breaking changes

What NOT to Do

  • •Do not create extensive documentation files
  • •Do not create multiple README files in subdirectories (unless essential)
  • •Do not document obvious code (code should be self-documenting)
  • •Do not create CHANGELOG.md unless explicitly requested