agentleFS
MicrosoftKnown publishermicrosoft/fabric-task-flows/.github/skills/fabric-document/SKILL.md

fabric-document

Skill49 starsChanged 6 months agoMITView on GitHub

Synthesizes all pipeline handoffs into a single human-readable project brief. Use when user says "generate docs", "create documentation", "document the project", or after validation passes. Do NOT use for deployment (use fabric-deploy) or architecture design (use fabric-design).

The file

We split this skill into the rules it gives an agent

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

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈1

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 2

    Very specific

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

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

    Read these files in parallel from _projects/[name]/docs/ (all are independent inputs):

    line 22
  2. Very specific:

    Follow the template in references/documentation-templates.md.

    line 33
  3. Distinctive:

    Do NOT create README.md, architecture.md, deployment-log.md, or decisions/*.md

    line 52

≈ “Common” is an estimate: at least 1 in 5 of the 364,980 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

⚠️ Artifacts-only mode: When deploy_mode is artifacts_only, this skill is NOT invoked — the pipeline runner handles this phase deterministically. The instructions below apply only when deploy_mode is live.

Fabric Documentation

Goal: Produce ONE deliverable — docs/project-brief.md — that a CTO can read in 10 minutes.

⚡ Pre-generated brief: The runner writes a structured project-brief.md synthesized from all handoffs before this skill is invoked, with <!-- AGENT: FILL --> markers where narrative polish is needed. Your job: (1) verify facts against the source handoffs, (2) add narrative polish so the brief reads like a CTO memo rather than a template, (3) replace every <!-- AGENT: FILL --> marker.

Instructions

Step 1: Read Pipeline Handoffs

Read these files in parallel from _projects/[name]/docs/ (all are independent inputs):

  • discovery-brief.md — problem statement and signals
  • architecture-handoff.md — items, waves, decisions, trade-offs, diagram
  • deployment-handoff.md — what was deployed, config rationale, manual steps
  • test-plan.md — acceptance criteria, edge cases
  • validation-report.md — pass/fail results

Step 2: Polish project-brief.md

Edit _projects/[name]/docs/project-brief.md in place (it is pre-generated).

Follow the template in references/documentation-templates.md. Key rules:

  1. ~1,500 words max — every fact appears exactly once
  2. Decisions inline — as a table in "Why This Architecture", NOT separate ADR files
  3. No separate files — do NOT create README.md, architecture.md, deployment-log.md, or decisions/*.md
  4. Synthesize, don't copy — distill the handoffs into narrative, don't paste YAML blocks

Step 3: Verify Completeness

The brief must answer these 5 questions:

  1. What problem are we solving? (from discovery)
  2. What did we build? (items + diagram from architecture)
  3. Why this approach? (decisions from architecture)
  4. How to deploy it? (from deployment handoff)
  5. Did it work? (from validation)

Constraints

  • Documents only — no architecture decisions or deployments
  • ONE output file: project-brief.md
  • Do NOT create README.md, architecture.md, deployment-log.md, or decisions/*.md

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.