القائمة
Markup language selection for documentation. Covers Markdown, AsciiDoc, reStructuredText, and Typst. Trigger terms: asciidoc, restructuredtext, rst, typst, document format, multi-format, PDF output.
التثبيت باستخدام Codex أو Claude انسخ هذا Prompt والصقه في Codex أو Claude أو مساعد آخر ليراجع صفحة Skill ويثبّتها لك.
استنادا إلى تصنيف SOC المهني
Write Architecture Decision Records when making significant technical choices. Use when selecting tools, patterns, frameworks, or making structural changes that future developers need to understand.
Write AGENTS.md files that serve as operating contracts for AI agents. Use when creating or updating AGENTS.md for a project. Trigger terms: AGENTS.md, agent instructions, agent contract, agent configuration, coding agent setup.
Quality rules for changelog entries. Use when validating, writing, or reviewing changelog content to ensure user-facing value communication.
Task completion sequence including verification, git, signaling, and handoff. Use when finishing a task or reporting status.
Architecture diagrams for documentation. Covers ASCII, Mermaid, C4, and D2. Applies C4 methodology by default. Trigger terms: diagram, flowchart, architecture diagram, sequence diagram, C4, mermaid, ascii diagram.
Classify documentation by audience and content type. Use when planning, auditing, or placing project documentation.
| name | document-formats |
| description | Markup language selection for documentation. Covers Markdown, AsciiDoc, reStructuredText, and Typst. Trigger terms: asciidoc, restructuredtext, rst, typst, document format, multi-format, PDF output. |
| Need | Format | Why |
|---|---|---|
| README, GitHub docs, quick docs | Markdown | Universal, renders everywhere |
| Multi-format output (PDF + HTML + EPUB) | AsciiDoc | Single source, native features |
| Cross-referenced technical book | AsciiDoc | Includes, xrefs, conditionals |
| Python project API docs | reStructuredText | Sphinx autodoc integration |
| Academic paper with math | Typst | Modern LaTeX alternative, fast |
| Polished customer deliverable | AsciiDoc or Typst | Professional output, no LaTeX |
| Slides from same source | AsciiDoc (reveal.js) or MARP | One source → slides + docs |
Switch when you need ANY of:
include::)<<section-id>>)If you only need HTML rendering in GitHub — stay with Markdown.
| Format | Diagram Support |
|---|---|
| Markdown | Mermaid (native in GitHub/GitLab), images for others |
| AsciiDoc | Kroki integration (all formats), native diagram blocks |
| RST | Sphinx extensions (sphinxcontrib-mermaid, etc.) |
| Typst | Embedded via packages or images |