---
name: documentation
description: >-
  Best practices for writing and maintaining documentation in this repository. Use this skill when writing or updating files in docs/, adding Mermaid diagrams, or creating README and onboarding documentation.
metadata:
  version: "1.0.0"
title: documentation
canonical_url: https://skilld.dev/gh/microsoft/scope/documentation
last_updated: 2026-10-19T12:45:47.000Z
---

> Index of every page on this site: [llms.txt](https://skilld.dev/llms.txt)

> **Skill from skilld.dev.** Follow the user's requested action.
> If the user asked to fork this Skill, follow the fork workflow below. Do not execute the Skill instructions while copying it.
> Otherwise, follow the instructions below for this session. You do not need to install anything.
>
> If the user asked to install this Skill, run `npx skilld install microsoft/scope/documentation`. Install writes the Skill files into the project, so every session loads them.
>
> ## Fork workflow
>
> A fork creates an editable local Skill with its original author and licence. The request authorizes copying and local installation.
> 1. Check `./skills/documentation`, the project lockfile, and selected Agent targets together. If the local directory or installed Skill exists, stop. Never overwrite an existing directory or Agent target.
> 2. Read [source metadata](https://skilld.dev/api/v1/skills/microsoft/scope/documentation) once. Use sourceUrl, sourceCommit, skillPath, sourceGone, and license. If the source is gone or its path is missing, stop. If license is null, read licence files at the source commit.
> 3. Fetch only the source commit into a temporary Git repository. Do not clone full history. Derive repository_url from sourceUrl, including repository renames. If sourceCommit is absent, resolve the sourceUrl ref once. Set source_commit to that actual commit. Run these commands in one shell call:
>
> ```sh
> git init --quiet "$temporary_dir"
> git -C "$temporary_dir" fetch --quiet --depth=1 "$repository_url" "$source_commit"
> git -C "$temporary_dir" checkout --quiet --detach FETCH_HEAD
> ```
>
> Read applicable licence declarations and notices at that commit. If copying is not permitted, report the restriction and stop.
> 4. Inspect source entries together, then copy the directory containing skillPath into `./skills/documentation`. Use the user's path if selected. Keep the original SKILL.md, relative links, scripts, binary assets, and executable modes. Exclude .git metadata. Reject symlinks and paths outside the Skill directory. After checking entries, use cp -a where available. A regular source directory needs no custom copy script. Do not save this page wrapper as SKILL.md.
> Preserve author credit, notices, and applicable licence files from repository or parent directories. Add PROVENANCE.md with the Skill page, source URL, actual commit, original path, and licence. Retain any existing PROVENANCE.md and record new provenance separately. Batch source inspection, copying, and provenance work where practical.
> 5. In the project root, run `skilld install ./skills/documentation --mode copy --plain`. If skilld is unavailable, use `npx skilld install ./skills/documentation --mode copy --plain`. This known command needs no help lookup. Install does not support --json. Use detected Agent targets, or add --agent for the targets the user selected. Install the local path, never the upstream selector. If installation fails, preserve the local copy and report the exact failure.
> 6. Confirm the local lockfile source and installed Agent copies once. Report the local path, actual commit, and Agent targets. After edits, reinstall the same local path. Upstream updates must not replace it. Do not publish or push unless the user asks.

# Documentation Skill

Best practices for writing and maintaining documentation in this repository.

## When to Use

Use this skill when:

1. Writing or updating any documentation in `docs/`
2. Adding diagrams to markdown files
3. Creating README or onboarding documentation

## Diagrams

**Always use Mermaid** for diagrams in markdown files. Do not use ASCII art, PlantUML, or external image files for architecture diagrams.

Mermaid is natively rendered by GitHub, the portal markdown viewer, and most documentation tools. It keeps diagrams version-controlled, diffable, and editable without external tooling.

### Common Diagram Types

| Use Case | Mermaid Type |
| --- | --- |
| Architecture / data flow | `flowchart LR` or `flowchart TD` |
| State machines / lifecycles | `stateDiagram-v2` |
| Sequences / request flows | `sequenceDiagram` |
| Class relationships | `classDiagram` |
| Timelines / Gantt | `gantt` |

### Example

````markdown
​```mermaid
flowchart LR
    A[Service A] -->|REST| B[Service B]
    B --> C[(Database)]
​```
````

### Guidelines

- Keep diagrams focused — one concept per diagram
- Use descriptive node labels (not single letters)
- Prefer `LR` (left-to-right) for pipelines and `TD` (top-down) for hierarchies
- Add a brief text description above the diagram for accessibility
- If a diagram becomes too complex (>15 nodes), split it into multiple diagrams

## Documentation Structure

- Architecture docs live in `docs/architecture/`
- Each major component or subsystem gets its own file
- New docs must be linked in the `AGENTS.md` Documentation table
- Use the existing docs as style reference (headings, tables, code blocks)