achieve-documentation-completeness

Generate READMEs, WHY-based code comments, API docs, and decision records.

1|Updated Feb 16, 2026
One-click install
npx skills add https://github.com/constellize/marketplace --skill achieve-documentation-completeness
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: achieve-documentation-completeness
Source: https://github.com/constellize/marketplace/tree/main/plugins/constellize-excellence/skills/achieve-documentation-completeness
Command: npx skills add https://github.com/constellize/marketplace --skill achieve-documentation-completeness

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Achieve documentation completeness across components by producing clear READMEs, meaningful code comments, up-to-date API docs, and a preserved memory of decisions.

Core Features & Use Cases

  • Generates comprehensive READMEs that explain purpose, setup, usage, and troubleshooting.
  • Inserts WHY-based code comments to capture decision rationale and trade-offs.
  • Maintains current API documentation and decision records in a memory bank for future maintainers.
  • Use Case: A new contributor onboarding to a large codebase with coherent docs and preserved context.

Quick Start

Draft and apply a complete documentation package to a target component with minimal steps.

Frequently Asked Questions about achieve-documentation-completeness

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

FAQPage Schema
How do I improve documentation completeness for software components?

Documentation completeness improves by generating structured READMEs, inserting WHY-based code comments, maintaining current API docs, and recording memory-bank decisions to preserve context for future maintainers.

What is the best way to write code comments that justify decisions?

The best way to write code comments is using a WHY-based approach that captures decision rationale and trade-offs, rather than just describing what the code does, ensuring context is preserved for future development teams.

How do I generate a comprehensive README for onboarding new contributors?

Generate a comprehensive README by following structured patterns that explicitly explain the component's purpose, setup instructions, usage examples, tests, and troubleshooting guidance for new contributors.

How do I maintain API documentation and decision records in a memory bank?

Maintain API documentation and decision records by storing them in a memory bank, ensuring current API docs and documented decisions are preserved for future maintainers across development teams.

Does this documentation approach work for large codebases with multiple teams?

Yes, this approach works for large codebases by applying memory-bank decisions across development teams, ensuring coherent docs and preserved context for new contributor onboarding.