Skills
.Work. You
Rest

agent-documentation

Community

Keep your code and docs in sync.

Software Engineering#code quality#documentation#technical writing#maintainability#agent documentation#developer guidelines
Authordonchrillo
Version1.0.0
Installs0

System Documentation

What problem does it solve?

This Skill ensures that your code documentation stays up-to-date with code changes, preventing technical debt and improving maintainability.

Core Features & Use Cases

  • Documentation-First for Changes: Enforces documentation updates before implementing breaking changes.
  • Inline Code Documentation: Guides on writing effective docstrings, type hints, and comments.
  • Architecture & API Docs: Provides standards for documenting structural and API-level changes.
  • Checklists: Offers comprehensive checklists for various documentation tasks (inline, change-log, module, API, architecture).
  • Use Case: When you introduce a new API endpoint, this skill's guidelines help you ensure that the endpoint is documented with request/response examples, error codes, and rate limits in the appropriate API documentation files.

Quick Start

Follow the guidelines in this skill to update the documentation for a new feature.

Dependency Matrix

Required Modules

None required

Components

references

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: agent-documentation
Download link: https://github.com/donchrillo/temu/archive/main.zip#agent-documentation

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.