documentation

Provide guidelines for writing clear, consistent, and accessible code and API documentation.

3|Updated Jun 12, 2026

Search Tags:#documentation #coding standards #code comments #API documentation #README

Ready to run

npx skills add https://github.com/weebcoder101/dreamcode --skill documentation-weebcoder101

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: documentation
Source: https://github.com/weebcoder101/dreamcode/tree/main/.dreamcode/skills/documentation
Command: npx skills add https://github.com/weebcoder101/dreamcode --skill documentation-weebcoder101

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill provides a comprehensive guide to documentation standards, making sure your code, APIs, and project documents are clear, consistent, and accessible.

Core Features & Use Cases

Standardized Documentation: Offers guidelines for writing docstrings, README files, API docs, and other project documentation.
Code Documentation: Instructs on creating effective docstrings and inline comments.
README Structure: Provides a template for creating informative README files.
API Documentation: Details what information should be included in API documentation.
Markdown Standards: Outlines best practices for writing Markdown.
Changelog Format: Offers a template for maintaining a changelog.
What Not to Document: Suggests what should be avoided in documentation.

Quick Start

Use the documentation skill to review and improve the documentation of your project.

Frequently Asked Questions about documentation

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

FAQPage Schema

What should be included in API documentation for a software project?▼

API documentation should detail endpoints, parameters, request examples, and response formats. Following standardized documentation ensures your APIs are accessible and consistent.

How do I structure a README file for my code repository?▼

A README file should include project overview, installation steps, usage examples, and contribution guidelines. Using a standardized README structure ensures your project is accessible and informative.

What are the best practices for writing code comments and docstrings?▼

Best practices for code comments and docstrings include keeping them clear, concise, and updated. Effective docstrings explain function purpose and parameters without stating the obvious.

What format should I use for maintaining a project changelog?▼

Maintain a changelog using a standardized format that lists versions, dates, and categorized changes like added, fixed, or removed features. This ensures project history remains accessible and consistent.

What information should I avoid including in project documentation?▼

Avoid documenting obvious code behavior, redundant implementation details, or outdated states. Knowing what not to document keeps your project documentation concise and focused on valuable insights.