documentation-standards

Name: documentation-standards
Availability: InStock
Author: JulianPani

Standardize project documentation structure and quality across README files and docs directories.

2|Updated Jan 29, 2026

Search Tags:#documentation #adr #readme #docs #style-guide #technical-writing

Ready to run

npx skills add https://github.com/julian-pani/agconf --skill documentation-standards-julian-pani

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: documentation-standards
Source: https://github.com/julian-pani/agconf/tree/main/.claude/skills/documentation-standards
Command: npx skills add https://github.com/julian-pani/agconf --skill documentation-standards-julian-pani

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps teams eliminate scattered, inconsistent, and overly verbose documentation by providing a clear structure for READMEs, docs, and agent instructions.

Core Features & Use Cases

Documentation hierarchy: Defines what belongs in README.md, docs/, inline comments, and AGENTS.md or CLAUDE.md.
Project organization: Guides how to structure docs for single-package projects and multi-module repositories.
Quality control: Promotes concise writing, relative links, focused topics, ADRs, and maintainable documentation practices.
Use case: Use it when you need to rewrite a bloated README, design a docs layout for a new project, or review documentation for consistency and completeness.

Quick Start

Ask the skill to review your project documentation and propose a cleaner README and docs structure that follows these standards.

Frequently Asked Questions about documentation-standards

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

FAQPage Schema

What is the best way to structure project documentation for a multi-module repository?▼

To structure project documentation, use a layered hierarchy with concise README front pages, dedicated docs directories, and ADRs. Enforce relative links and clear audience separation to maintain consistency across single-package or multi-module repositories.

How do I write a concise README that follows technical writing standards?▼

Writing a concise README involves keeping front pages short, layering detailed information into a docs directory, and using relative links. Following a style-guide ensures the README remains maintainable and clearly separates audiences.

When should I use Architecture Decision Records in my docs directory?▼

Use Architecture Decision Records (ADRs) in your docs directory to log important technical choices and their rationales. ADRs enforce documentation standards by providing a consistent, maintainable history of architectural changes for project audiences.

Does this documentation standard work for both single-package projects and multi-module repositories?▼

Yes, these documentation standards apply to both single-package projects and multi-module repositories. The guidelines scale by defining specific documentation hierarchies, ensuring concise READMEs and appropriate docs directory layering regardless of project size.

How do I review existing project docs to eliminate scattered and verbose content?▼

Review existing project docs by checking for concise front pages, layered documentation structures, and proper ADR conventions. Rewriting bloated content into a clean README and docs layout enforces consistency and removes verbosity.

What belongs in agent instruction files like AGENTS.md or CLAUDE.md?▼

Agent instruction files like AGENTS.md or CLAUDE.md belong at the root level and contain specific guidance for automated agents. They are part of a standard documentation hierarchy that separates human-readable READMEs from machine-focused instructions.