Agent ยท Tech Writer ๐ โ
E11 Tech Writer (skill: e11-agent-tech-writer) โ the documentation specialist. Fluent in CommonMark, DITA, OpenAPI, and Mermaid. Optimized for "I need a document, not a by-product" requests, with a persistent standards memory that survives sessions.
What it produces โ
- Project docs, architecture writeups, API references, explainers.
- Mermaid diagrams โ sequence, flowchart, ER, state.
- Validation reports โ does this doc meet our standards?
- Doc indexes โ via
e11-index-docs.
When to use it โ
- A document is the deliverable, not the side-effect of another workflow.
- An existing doc needs review for clarity, structure, or convention adherence.
- You need brownfield project documentation (
[DP]) with a writer's editorial hand.
How to invoke โ
Invoke e11-agent-tech-writer. Its menu mixes skill dispatch and prompt-driven commands (the four writing commands are prompt files bundled with the agent):
| Code | Command | Kind | Purpose |
|---|---|---|---|
[DP] | Document Project | skill โ e11-document-project | Brownfield analysis โ project docs |
[WD] | Write Document | prompt | Produce a doc per the standards sidecar |
[MG] | Mermaid Generate | prompt | Diagram from a description |
[VD] | Validate Document | prompt | Review a doc against standards |
[EC] | Explain Concept | prompt | Clear technical explanation with examples |
[ID] | Index Docs | skill โ e11-index-docs | Build an index.md for a docs folder |
[QK] | Query Knowledge | skill โ e11-knowledge | Pull an alloy doc directly |
The standards sidecar โ
The Tech Writer loads .foundry/_memory/tech-writer-sidecar/documentation-standards.md as a persistent fact on every activation. When you correct a convention once ("we always spell it datastore"), have it update the standards file โ every future session inherits the rule. This is the one agent with durable, file-backed memory by default.
Example session โ
You: e11-agent-tech-writer
TW: ๐ E11 Tech Writer. Standards sidecar loaded (14 conventions).
You: WD โ a runbook for rotating the service-to-service signing keys.
TW: Scope check: audience ops engineers, format runbook (numbered,
verification step after each action). Sources: I'll pull
alloy://shared/infrastructure/cloud-run-conventions.md for deploy specifics.
Draft at docs/runbooks/rotate-s2s-keys.md โ validating against
the sidecar standards... 2 fixes applied. Done.Gotchas โ
- Prompt commands are agent-local.
[WD]/[MG]/[VD]/[EC]live inside the agent-skill directory โ they're not standalone skills you can invoke without the agent. - Editorial reviews are separate skills. For a clinical copy-edit or a structural pass, use
e11-editorial-review-prose/e11-editorial-review-structureโ the writer can invoke them, and the PRD/brief finalize gates use them asdoc_standardsreviewers. - Keep the sidecar in the repo. It lives under
.foundry/_memory/in your project; losing it means re-teaching conventions.
Customizing โ
Persona, menu, and facts: .foundry/custom/e11-agent-tech-writer.toml. Add org writing rules as persistent_facts entries, or point a menu item at your own prompt file. See Customization.
Source โ
src/foundry/workflows/1-analysis/e11-agent-tech-writer/SKILL.md
See also: Phase 1 โ Analysis ยท Agent quick-reference.