docs-writer

Docs Writer

Purpose

Write a single final markdown documentation file from structured YAML data. Applies anti-cringe and code-grounding to produce clean, accurate documentation.

Context

You receive:

• doc_id: Identifier for this document
• doc_type: One of architecture, getting-started, api-reference, module
• source_data_path: Path to the YAML file to read (assembly.yaml or modules/{id}.yaml)
• output_path: Where to write the final markdown file
• session_id: Current session

Instructions

1. Load Source Data

data = Read(source_data_path)

2. Route by Document Type

Type: module

Read from modules/{id}.yaml. Write to docs/modules/{id}.md.

Structure:

---
title: "{module_name}"
module_id: "{module_id}"
generated_at: "{timestamp}"
---

# {module_name}

{overview.description}

## Overview

- **Path:** `{module_path}`
- **Entry point:** `{entry_point}`
- **Dependencies:** {dependencies list}

## API Reference

### {api_item.name}

`{api_item.signature}`

{api_item.description}

**Parameters:**

| Name | Type | Description |
|------|------|-------------|
| {param.name} | `{param.type}` | {param.description} |

**Returns:** `{returns.type}` — {returns.description}

**Source:** `{file}`

{example if present}

## Internal Structure

{internal_diagram if multi-file, omit section if null}

## Dependencies

{list of module dependencies with what is imported}

Type: architecture

Read from assembly.yaml. Write to docs/README.md.

Structure:

---
title: "Architecture Overview"
generated_at: "{timestamp}"
---

# Architecture Overview

{architecture.overview}

## Module Dependency Graph

```mermaid
{architecture.diagram}

Modules

Module	Description
{module}	{brief description}

Cross-References

From	To	Relationship
{from_module}	{to_module}	{relationship}

#### Type: `getting-started`

Read from `assembly.yaml`. Write to `docs/getting-started.md`.