Skip to content

Comments

docs: reorganize documentation conventions with progressive disclosure (MT-45)#23

Merged
mbailey merged 2 commits intomasterfrom
docs/MT-45-create-documentation-conventions-directory-with
Dec 23, 2025
Merged

docs: reorganize documentation conventions with progressive disclosure (MT-45)#23
mbailey merged 2 commits intomasterfrom
docs/MT-45-create-documentation-conventions-directory-with

Conversation

@ai-cora
Copy link
Collaborator

@ai-cora ai-cora commented Dec 23, 2025

Summary

  • Reorganize documentation conventions into docs/conventions/documentation/ directory with progressive disclosure structure
  • Add clear guidance for package vs core documentation organization
  • Establish AGENTS.md as the industry standard for AI agent instructions
  • Define file suffix conventions (-guide, -reference, -concepts)

Changes

Created 7 new files in docs/conventions/documentation/:

  • README.md: Overview of documentation types with quick reference
  • readme-guide.md: Templates for project, directory, and package READMEs
  • root-documentation.md: Files allowed outside docs/ (AGENTS.md, SKILL.md, etc.)
  • docs-structure.md: Category-based vs topic-based organization
  • docs-structure-concepts.md: Diátaxis framework background
  • command-usage.md: CLI help text and reference doc templates
  • writing-style.md: Markdown, tone, formatting conventions

Updated:

  • docs/conventions/README.md: Link to new documentation directory
  • SKILL.md: Reference new documentation structure

Deleted:

  • docs/conventions/documentation.md (content migrated)
  • docs/conventions/documentation-organization.md (content migrated)

Key Decisions

  1. Two documentation approaches:

    • Category-based (Diátaxis) for metool core and large projects
    • Topic-based with suffixes for metool packages (simpler default)
  2. AGENTS.md is the industry standard for AI coding assistants (60k+ repos)

    • SKILL.md is for Claude Code skill definitions (different purpose)
  3. docs/commands/ directory pattern for package command reference

    • Files named identically to binaries in bin/

Test plan

  • All markdown files render correctly
  • Links between documentation files work
  • Review that SKILL.md doesn't duplicate content from docs/

🤖 Generated with Claude Code

ai-cora and others added 2 commits December 23, 2025 17:47
…e (MT-45)

Create docs/conventions/documentation/ directory with structured files:
- README.md: Overview of documentation types with links
- readme-guide.md: Templates for project, directory, package READMEs
- root-documentation.md: Files outside docs/ (AGENTS.md, SKILL.md, etc.)
- docs-structure.md: Category-based vs topic-based organization
- docs-structure-concepts.md: Diátaxis framework background
- command-usage.md: CLI help text and reference doc templates
- writing-style.md: Markdown, tone, formatting conventions

Key changes:
- Lead with package recommendations (simple topic-based)
- Add file suffixes convention (-guide, -reference, -concepts)
- Define AGENTS.md as industry standard for AI agent instructions
- Add docs/commands/ pattern for command reference
- Update SKILL.md to reference new documentation structure

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- AGENTS.md: Reduce to 3 lines pointing to SKILL.md (was 46 lines)
- CLAUDE.md: Point to /metool skill (was pointing to AGENTS.md)
- SKILL.md: Condense from 682 to 225 lines (67% reduction)
  - Keep procedural knowledge (package creation, Python scripts)
  - Add "How mt Works" section (function vs binary)
  - Replace detailed docs with references to docs/ files

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@mbailey mbailey merged commit f30f74e into master Dec 23, 2025
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants