documents

Files (33)

• SKILL.md
• README.md · parts/diagram-generator/
• SKILL.md · parts/diagram-generator/
• openai.yaml · parts/diagram-generator/agents/
• diagram-patterns.md · parts/diagram-generator/references/
• create_sample_diagrams.py · parts/diagram-generator/scripts/
• render_diagram.py · parts/diagram-generator/scripts/
• SKILL.md · parts/markdown-html-orchestrator/
• information_density_canon.md · parts/markdown-html-orchestrator/references/
• orchestrator_routing_patterns.md · parts/markdown-html-orchestrator/references/
• single_file_html_discipline.md · parts/markdown-html-orchestrator/references/
• doctype_classifier.py · parts/markdown-html-orchestrator/scripts/
• output_path_resolver.py · parts/markdown-html-orchestrator/scripts/
• route_explainer.py · parts/markdown-html-orchestrator/scripts/
• SKILL.md · parts/md-document/
• md_document_template.html · parts/md-document/assets/
• information_density_patterns.md · parts/md-document/references/
• single_file_html_discipline.md · parts/md-document/references/
• toc_and_nav_ux.md · parts/md-document/references/
• html_renderer.py · parts/md-document/scripts/
• interactivity_injector.py · parts/md-document/scripts/
• markdown_parser.py · parts/md-document/scripts/
• SKILL.md · parts/md-review/
• md_review_template.html · parts/md-review/assets/
• diff_rendering_canon.md · parts/md-review/references/
• pr_annotation_ux.md · parts/md-review/references/
• severity_coding.md · parts/md-review/references/
• annotation_extractor.py · parts/md-review/scripts/
• diff_parser.py · parts/md-review/scripts/
• review_html_renderer.py · parts/md-review/scripts/
• SKILL.md · parts/read-docs/
• check_docx.py · parts/read-docs/scripts/
• extract_docx.py · parts/read-docs/scripts/

SKILL.md (first lines)

# documents — written material in and out

> Home branch in Memora: `root/skill/documents`.

## Choosing a part

| Part | What it covers |
|---|---|
| `parts/md-document/` | Long-form markdown (specs, RFCs, reports, plans, explainers) → a single-file, lightly interactive HTML document with sticky TOC and scrollspy |
| `parts/markdown-html-orchestrator/` | The general markdown → single-file HTML converter, for any markdown in a project |
| `parts/md-review/` | A PR writeup or code review with diff blocks and `[!BLOCKER]/[!MAJOR]/[!MINOR]/[!NIT]` callouts → a readable review document |
| `parts/read-docs/` | Reading `.doc`/`.docx` quickly via python-docx |
| `parts/diagram-generator/` | Diagrams from natural language, notes, code, schemas, tables or existing source |

**PDF, Word-creation and spreadsheet engines are not bundled.** The usable ones
are source-available under terms that forbid repackaging, so this kit ships
neither (see `PROVENANCE.md`). When the deliverable must be an `.xlsx`, a filled
PDF form or a Word file with tracked changes, install that engine from its own
source first and record the install there — do not hand-edit a zip of XML.

## Rules

- **HTML output is one file, opened locally.** No build step and no CDN
  dependency for something the user will send to someone; check it in a browser
  before calling it done.
- **Office files are edited by a tool, not by hand.** A re-zipped XML rewrite is
  how documents get corrupted; if no engine is installed, say so and install the
  right one instead of imitating it.
- **Prose quality is not optional**: long documents go through `antislop`
  before delivery.
- **Ask when it matters**: the output format when the request could mean HTML or
  a Word file, a document that will be signed or submitted formally, and any file
  destined for someone outside the workspace.
- **What the document decided** becomes a memory node under
  `root/skill/documents`; the file itself belongs with its project.

## Related

`decks` (slides), `antislop` (prose), `documentation-writer` (formal reports),
`design` (typography and layout of the rendered page).

From youlianvr/oper-share, CC-BY-4.0.

More from youlianvr/oper-share