agentleFS
frameforgedframeforged/technical-documentation-framework/document-architecture/SKILL.md

document-architecture

Skill2 starsChanged 4 months agoApache-2.0View on GitHub

Designs the documentation package, table of contents, section order, section purpose, examples, diagrams, and cross-reference plan.

3 other projects use a version of this.

Adopted by

Most recently taken up by

The file

We split this skill into the rules it gives an agent

3 rules. About 0 are common, 3 are distinctive, and 0 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈3

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 0

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Use this as a default:

    line 43
  2. Distinctive:

    Every major section should have a clear purpose.

    line 65
  3. Distinctive:

    Do not create unnecessary files for small products.

    line 66

≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Document Architecture Skill

Purpose

Design the structure before writing.

Good documentation has a navigable architecture. The reader should know where to start, where to find concepts, where to find integration details, and where to troubleshoot.

Output format

# Documentation Architecture

## Recommended Documentation Package

## Main README Structure

## Detailed Documents

## Section Order

## Section Purpose Table

| Section | Purpose | Target Audience | Required Content | Example Required |
|---|---|---|---|---|

## Diagram Recommendations

## Glossary Placement

## Cross-reference Plan

## Content That Should Not Be Included

Standard package recommendation

Use this as a default:

docs/
├── README.md
├── overview.md
├── getting-started.md
├── concepts.md
├── architecture.md
├── configuration.md
├── api-reference.md
├── examples.md
├── troubleshooting.md
├── glossary.md
└── faq.md

Rules

  • The README should be short and navigational.
  • Deep explanations should live in detailed docs.
  • The glossary should be referenced from concept-heavy sections.
  • Every major section should have a clear purpose.
  • Do not create unnecessary files for small products.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.