documentation

Name: documentation
Availability: InStock
Author: Epicenter

Write READMEs and inline comments explaining code rationale and usage.

4.7k|374|Updated Mar 16, 2023

Search Tags:#documentation #readability #maintainability #readme #code-organization #inline-comments

Ready to run

npx skills add https://github.com/EpicenterHQ/epicenter --skill documentation-epicenterhq

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: documentation
Source: https://github.com/EpicenterHQ/epicenter/tree/main/.agents/skills/documentation
Command: npx skills add https://github.com/EpicenterHQ/epicenter --skill documentation-epicenterhq

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Documentation explains why code is organized the way it is, not just what it does, saving time for future maintainers.

Core Features & Use Cases

Explain the intent behind modules, folders, and APIs to improve maintainability.
Provide READMEs and code comments that clarify design decisions and usage patterns.
Use Case: A dev team reviewing a large feature adds a README to describe module boundaries and rationale.

Quick Start

Create a concise README and inline comments for the new module to capture its purpose and usage.

Frequently Asked Questions about documentation

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

FAQPage Schema

How do I write a README that explains code organization for future maintainers?▼

To write a README for code organization, document the intent behind modules, folders, and APIs to clarify design decisions. This explains why code is structured a certain way, saving time for future maintainers who need quick access to rationale.

What is the best way to document design decisions during a large refactor?▼

The best way to document design decisions during a large refactor is adding concise READMEs and inline comments. Capturing module boundaries and rationale ensures multi-team projects maintain readability and maintainability with standard formatting.

When do I need to add inline comments to capture code rationale?▼

You need to add inline comments to capture code rationale when working on new modules, large refactors, or multi-team projects. This satisfies requirements for consistent documentation practices by ensuring maintainers understand usage patterns.

Does standard formatting for code documentation improve readability across dev teams?▼

Yes, standard formatting for code documentation improves readability across dev teams. Using section conventions and structured docs clarifies module boundaries and APIs, ensuring maintainability requirements are consistently met across multi-team projects.

Can I use standard section conventions to document module boundaries and usage patterns?▼

Yes, you can use standard section conventions to document module boundaries and usage patterns. Applying consistent formatting and structured docs to READMEs and inline comments captures design intent, satisfying maintainability requirements.