agentleFS
Sign inStart free
MrCipherSmithMrCipherSmith/goodai-base/skills/autodoc-assembler/SKILL.md

autodoc-assembler

Skill0 starsChanged 5 months agoMITView on GitHub

Phase 5 subagent for autodoc-orchestrator. Assembles all documentation sections into a cohesive package: main README.md and navigation index. Use when: dispatched by autodoc-orchestrator Phase 5. NOT for: direct user invocation.

The file

We split this skill into the rules it gives an agent

1 rule. About 0 are common, 0 are distinctive, and 1 is very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈0

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 1

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Read each docs/*.md file. Note:

    line 54

≈ “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

autodoc-assembler

Purpose

Produce the final documentation entry point. Read all generated sections, verify cross-references, write the main README and navigation index.

Iron Laws

#Law
1Read ALL docs/*.md before writing — no section may be skipped
2README.md must be self-contained enough to orient a new developer
3All cross-links between docs must use relative paths
4Do NOT repeat content from sections — summarize and link

Input Contract

docs_sections: "jobs/<job>/docs/*.md"   # all generated sections
project_map: "jobs/<job>/artifacts/project-map.md"
architecture: "jobs/<job>/artifacts/architecture.md"
JOB_DIR: "<job directory>"
PROJECT_DIR: "<project path>"

Output Contract

status: "DONE" | "DONE_WITH_CONCERNS"
summary: "<2-3 sentences: what's in the final package, any gaps>"
concerns: ["<missing info, broken cross-refs, TODO items left by writers>"]
artifact_path: "jobs/<job>/docs/README.md"

Workflow

Step 1: Inventory All Sections

Read each docs/*.md file. Note:

  • What sections were successfully written
  • Any [TODO: ...] markers left by writers (collect into concerns)
  • Missing sections that were expected but not generated

Step 2: Write docs/README.md

# <Project Name>

> <one-line description from project-map>

## Overview
<2-3 paragraphs: what the project is, who it's for, main capabilities>

## Architecture
<3-5 bullet summary of architectural style and key components>
→ Full details: [Architecture](architecture.md)

## Quick Start
<condensed 4-step setup: clone → install → configure → run>
→ Full guide: [Onboarding](onboarding.md)

## Documentation

| Document | Description |
|----------|-------------|
| [Getting Started](onboarding.md) | Setup, local dev, common tasks |
| [Architecture](architecture.md) | System design, components, data flow |
| [Module Reference](modules.md) | Per-module breakdown |
| [API Reference](api-reference.md) | Endpoint documentation |
| [Data Models](data-models.md) | Schemas and database structure |

## Tech Stack

| Layer | Technology |
|-------|-----------|
<from project-map>

## Generated By
This documentation was generated automatically by [autodoc](https://github.com/MrCipherSmith/goodai-base).
Generated: <date>

Step 3: Write docs/index.md

# Documentation Index

## <Project Name> — Documentation

Generated: <date> | Source: `<project path>`

### Contents

- **[README](README.md)** — Project overview and quick start
- **[Getting Started](onboarding.md)** — Full setup guide
- **[Architecture](architecture.md)** — System design
- **[Module Reference](modules.md)** — Module-by-module breakdown
- **[API Reference](api-reference.md)** — REST/gRPC/GraphQL endpoints
- **[Data Models](data-models.md)** — Database schemas

### Modules Documented
<list of modules from analysis>

### Coverage Notes
<any TODOs or gaps noted during generation>

Step 4: Return Summary

In the response summary, include:

  • Total sections generated
  • Any TODO items that need human review
  • Suggested next steps (e.g., "API reference has 3 endpoints marked TODO: add description")

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.

Check your setup, free