skills.rest
donchrillo
donchrilloCOMMUNITY
Explore all skills by this author →
GitHub

agent-documentation

Guide agents in maintaining code documentation alongside development using Markdown and Mermaid diagrams.

Updated Nov 21, 2025
Search Tags:#code quality#documentation#technical writing#maintainability#agent documentation#developer guidelines
One-click install
npx skills add https://github.com/donchrillo/temu --skill agent-documentation
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: agent-documentation
Source: https://github.com/donchrillo/temu/tree/main/.opencode/skills/agent-documentation
Command: npx skills add https://github.com/donchrillo/temu --skill agent-documentation

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

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.

Frequently Asked Questions about agent-documentation

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I keep code documentation in sync with code changes?▼

Keeping code documentation in sync requires enforcing documentation-first updates before implementing breaking changes, covering inline code, architecture, and API levels throughout development.

What is the best way to document API endpoints and error codes?▼

The best way to document API endpoints is by using structured guidelines that require request/response examples, error codes, and rate limits within dedicated API documentation files.

How do I write inline code documentation and docstrings effectively?▼

Writing effective inline code documentation involves following standards for docstrings, type hints, and comments to ensure code maintainability and clarity for developers.

When do I need architecture-level documentation and ADRs?▼

Architecture-level documentation and ADRs are needed during new features or refactoring to map structural changes using Mermaid diagrams and Markdown formats.

Can I use Markdown and Mermaid diagrams for technical writing guidelines?▼

Yes, you can use Markdown and Mermaid diagrams for technical writing, as these formats are specifically emphasized for maintaining architecture-level documentation and structural diagrams.

Related Skills

Explore More Software Engineering Skills→
klounekloune

docs-writer

Enforce documentation standards for Gemini CLI repositories.

Community
Intermediate
caterpi11arcaterpi11ar
3

release

Automate version increments and generate bilingual release notes via git.

Community
Intermediate
causify-aicausify-ai
144

Fix type hints

Analyze Python code and fix type hint mismatches and inconsistencies.

Official
Intermediate
C0ntr0lledCha0sC0ntr0lledCha0s
8

documentation-writer

Generate module READMEs, user guides, and technical references from source code.

Community
Basic