Skip to content
Skills Library
Documents & office · Writing

codex-document-writer

/codex-document-writer

Use for documents, reports, memos, guides, academic papers, or formal text that needs clear structure, reliable tone, formatting, and diagrams.

Licence
MIT
Last repository change
23.10.2026

Assessment and security

90/ 100Class: good
Format25 / 25
Frontmatter with name and description, valid name, description up to 1,024 characters, name matching the folder.
Discoverability25 / 25
Description explains when to use the skill, has a reasonable length and uses third person.
Content25 / 35
At least 150 words and at most 500 lines, headings, step lists, examples or code.
Hygiene15 / 15
No placeholders such as TODO, no Windows paths, with a licence.
Riskno signals detected in the scan
Files in this package
11
Scripts
0
HTML comments
0
URLs in SKILL.md
0
Deprecation

No signals detected. Repository changed on 23.10.2026, without references to retired models or APIs.

Licence

MIT, open: use and modify while retaining author attribution.

What it does and when to use it

Use for documents, reports, memos, guides, academic papers, or formal text that needs clear structure, reliable tone, formatting, and diagrams.

Original author description

Use for documents, reports, memos, guides, academic papers, or formal text that needs clear structure, reliable tone, formatting, and diagrams.

How it works

  1. TL;DR
  2. Activation
  3. Hard Rules
  4. Document Flow
  5. Diagram Integration Protocol
  6. Report Type Router
  7. Quality Gate (Before Delivery)
  8. Reference Files
Original SKILL.md headings · 108 lines, 880 words
SKILL.md preview
---
name: codex-document-writer
description: Use for documents, reports, memos, guides, academic papers, or formal text that needs clear structure, reliable tone, formatting, and diagrams.
load_priority: on-demand
---

## TL;DR
Load before writing or revising any document, report, proposal, memo, guide, academic paper, or long-form explanation. The goal is reader clarity: correct context, full meaning, professional structure, reliable tone, compact wording, proper diagrams, and polished formatting — without making the reader infer missing intent.

## Activation

1. Activate when the task involves drafting, rewriting, summarizing, formatting, or improving documents, reports, memos, proposals, guides, handoffs, emails, academic papers, or formal text.
2. Activate on `$doc`, `$report`, `$write`, `$diagram`, `$báo-cáo`, "soạn tài liệu", "viết báo cáo", "làm văn bản chuyên nghiệp", "viết rõ ràng hơn", "vẽ sơ đồ".
3. Auto-load with `codex-reasoning-rigor` when the document is decision-heavy, high-stakes, or evidence-based.
4. Auto-load with `codex-doc-renderer` when the deliverable is `.docx`.

## Hard Rules

- Always identify purpose, audience, context, and expected use before choosing wording.
- Start with the document outcome, not background narration.
- Use complete sentences with explicit actor, action, object, and outcome.
- Keep each paragraph focused on one message; do not make the reader infer the point.
- Be detailed where meaning depends on detail, but remove filler, repeated framing, and synonym stacking.
- Use humble, reliable wording: state what is verified, what is inferred, and what remains uncertain.
- Do not overclaim. Avoid "clearly", "obviously", "guaranteed", "always", and "never" unless evidence supports them.
- For Vietnamese, use natural UTF-8 Vietnamese, correct context labels, and professional but readable wording.
- Every diagram must answer a specific question. No decorative diagrams.
- Every report section must earn its place. No empty sections or placeholder text.

## Document Flow

Before drafting:

1. Determine document type and reader.
2. Pick the matching structure:
   - For reports → `references/report-structures.md`
   - For general documents → `references/document-types.md`
   - For academic/university work → `references/academic-report-patterns.md`
3. Add diagrams where visual explanation is needed → `references/diagram-patterns.md`
4. Apply content writing patterns → `references/content-writing-patterns.md`
5. Apply sentence rules from `references/sentence-quality.md`.
6. Apply reliability rules from `references/tone-reliability.md`.
7. Apply Vietnamese wording rules from `references/vietnamese-style.md` when writing Vietnamese.
8. Apply formatting rules from `references/formatting.md`.

## Diagram Integration Protocol

When the document needs visual explanation:

1. Check `references/diagram-patterns.md` → Diagram Selection Decision Table
2. Choose the simplest diagram type that answers the reader's question
3. Use Mermaid syntax for rendered documents, ASCII for plain text
4. Add a caption/title before every diagram
5. Limit: max 15 nodes per diagram, split if larger
6. Verify render before delivering

### Quick Diagram Dispatch

| Need | Diagram Type | Mermaid Keyword |
|---|---|---|
| System architecture | Flowchart with subgraphs | `flowchart TB` |
| API interaction flow | Sequence diagram | `sequenceDiagram` |
| Database schema | ER diagram | `erDiagram` |
| Status/workflow transitions | State diagram | `stateDiagram-v2` |
| Project timeline | Gantt chart | `gantt` |
| Branch strategy | Git graph | `gitGraph` |
| Feature breakdown | Mind map | `mindmap` |
| Distribution/proportion | Pie chart | `pie` |
| Milestone overview | Timeline | `timeline` |

## Report Type Router

| Signal in User Request | Load Reference |
|---|---|
| "báo cáo tiến độ", "progress report" | `references/report-structures.md` → Progress Report |
| "phân tích", "analysis", "analytical" | `references/report-structures.md` → Analytical Report |
| "đề xuất", "proposal" | `references/report-structures.md` → Proposal |
| "sprint report", "release notes" | `references/report-structures.md` → Sprint Report |
| "incident", "postmortem", "sự cố" | `references/report-structures.md` → Incident Report |
| "đồ án", "assignment", "bài tập lớn", "luận văn" | `references/academic-report-patterns.md` |
| "memo", "update", "thông báo" | `references/document-types.md` → Business Memo |
| "hướng dẫn", "guide", "tutorial" | `references/document-types.md` → User Guide |
| "handoff", "bàn giao" | `references/document-types.md` → Session Handoff |
| "README", "documentation" | `references/content-writing-patterns.md` → README Template |

## Quality Gate (Before Delivery)

Before delivering any document:

- [ ] First section answers the reader's primary question
- [ ] Every claim backed by evidence
- [ ] Tables used for comparisons, not narratives
- [ ] Every diagram has a caption and answers a specific question
- [ ] Metrics shown with target vs actual
- [ ] Clear "Next Steps" or "Required Decision" section
- [ ] Risks listed with severity AND mitigation
- [ ] For Vietnamese: proper section headings and figure/table numbering
- [ ] Scannable: headings + tables alone convey the gist
- [ ] No wall-of-text paragraphs (max 5-6 lines per paragraph)
- [ ] No "empty calories" phrases ("it is important to note that...", "in order to...")

## Reference Files

- `references/document-types.md`: templates for reports, memos, proposals, guides, handoffs, summaries, and executive updates.
- `references/report-structures.md`: 8 report types — progress, analytical, proposal, comparison, sprint, incident, research, and Vietnamese academic.
- `references/diagram-patterns.md`: complete Mermaid diagram reference — flowchart, sequence, ER, state, Gantt, C4, journey, mindmap, pie, gitGraph, timeline + ASCII alternatives + quality rules.
- `references/content-writing-patterns.md`: PREP framework, heading hierarchy, active voice, "So What?" test, Vietnamese content patterns, anti-patterns, and README template.
- `references/academic-report-patterns.md`: Vietnamese university report template — 6 chapters, cover page, TOC, figure/table lists, formatting standards, citation guide, and common academic phrases.
- `references/sentence-quality.md`: sentence patterns that keep meaning complete, compact, and easy to read.
- `references/tone-reliability.md`: humility, evidence wording, uncertainty, and confidence calibration.
- `references/vietnamese-style.md`: Vietnamese document labels, wording patterns, and anti-filler rules.
- `references/formatting.md`: professional headings, tables, bullets, spacing, and scan-friendly layout rules.
Files in this package (11)
  • SKILL.md 7 KB
  • agents/openai.yaml 1 KB
  • references/academic-report-patterns.md 9 KB
  • references/content-writing-patterns.md 7 KB
  • references/diagram-patterns.md 10 KB
  • references/document-types.md 3 KB
  • references/formatting.md 2 KB
  • references/report-structures.md 8 KB
  • references/sentence-quality.md 2 KB
  • references/tone-reliability.md 2 KB
  • references/vietnamese-style.md 3 KB

Versions

The database has no other skills named codex-document-writer.

Database snapshot: 13.11.2026 · package version b7b15f20cc1d (SHA-256 digest of the entire package)

Downloads in the last 30 days: 0 · ranking

Report a problem with this skill: harmful content, incorrect descriptions or an author’s removal request.

Similar skills

  • 90professional-writer
    Write business letters, reports, memos, meeting notes, and formal documents in French, English, or Arabic. Use for any professional document that must be polished and correctly toned.
  • 100docx
    Create, read, edit, fill, and format editable Word documents (.docx / Word文档 / 文档) using OpenXML SDK (.NET). Use for reports/报告, proposals, memos, forms, contract formatting/合同, Chinese government documents/公文 (GB/T 9704), academic papers (IEEE, ACM, APA 7 professional, MLA 9,…
  • 100document-conversion
    This skill should be used when users need to convert PDFs (especially with tables or figures), mentions 'convert', 'PDF', 'document processing', has complex academic papers to import, or asks about document conversion options.
  • 100document-conversion
    This skill should be used when users need to convert PDFs (especially with tables or figures), mentions 'convert', 'PDF', 'document processing', has complex academic papers to import, or asks about document conversion options.
  • 90s4h-writing-report
    Writes and audits business reports, briefing documents, and information reports for answer-first structure, precision, hierarchy, and navigability. Use when a report buries its findings, is written for the writer rather than the reader, or lacks clear structure. Triggers: 'write…
  • 100document-format-skills
    Chinese Word document formatting toolkit for .docx/.doc/.wps workflows. Use when Codex needs to diagnose document formatting, fix mixed Chinese/English punctuation and spacing, apply official/academic/legal/custom presets, normalize tables and page numbers, preserve or output…

Feedback and reports

Your message goes to Bartosz Sokoliński. An email address is needed only for a reply. See the privacy policy.