Technical Writing
Documentstechnical-writingTechnical Writing is an Agent Skill for documents published in the saffron-health/libretto repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.
Guide for writing effective technical documentation, specs, and markdown files. Use when creating or editing specs, documentation, READMEs, AGENTS.md files, or any markdown content in the codebase.
How to use this skill
Bring this guide into your coding agent with a prompt tailored to the tool you use.
- Open your project in Codex.
- Copy and paste the prompt below.
- Review files and risks before approving any action.
Inspect the Agent Skill at https://github.com/saffron-health/libretto/blob/HEAD/.agents/skills/technical-writing/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/technical-writing, but wait for my approval before writing files or running scripts.
Copying this prompt does not install or run the skill. Review third-party files before use.
Technical Writing
Audience
Assume readers are at least as smart as you, so do not over-explain. State information once and move on.
Style
Write concise, complete sentences using active voice and present tense. Each paragraph or bullet should express a single idea.
Formatting
- Do not use emojis.
- Do not use bold or italics.
- Use headings, lists, and code blocks only when they add clarity.
- Use fenced code blocks with language identifiers.
Paths
Always use relative file paths: docs/testing.md, not /Users/name/project/docs/testing.md.
Do Not Repeat
Link to existing resources instead of duplicating content. Reference other docs, web pages, or files rather than restating their information.