Skip to content

VidyFoo/antigravity-skill-engine / .agent/skills/4-tools/doc-writing

doc-writing

Unverified

技术文档工程 - Diátaxis框架 / PDF / DOCX / XLSX / PPTX 处理。Create, maintain, and structure clear technical documentation.

Documentation Engineering

Purpose

Code tells you how. Documentation tells you why and what. We treat documentation as an engineering artifact: structured, versioned, and maintained.

When to Use This Skill

  • New Project: "Write a README."
  • Knowledge Transfer: "Explain how this works."
  • API: "Document this endpoint."
  • Handover: "Create a user guide."

Core Framework: Diátaxis

Classify your document into one of four quadrants to ensure clarity.

  1. Tutorials (Learning-oriented): A lesson to get a beginner started.
    • Example: "Build your first Todo App in 5 minutes."
    • Tone: Inspiring, step-by-step, no choices (follow me).
  2. How-to Guides (Problem-oriented): A recipe to solve a specific problem.
    • Example: "How to reset your password."
    • Tone: Practical, concise, steps 1-2-3.
  3. Reference (Information-oriented): Technical description of machinery.
    • Example: "User API Class Specification."
    • Tone: Dry, accurate, complete.
  4. Explanation (Understanding-oriented): Context and background.
    • Example: "Why we chose Rust over C++."
    • Tone: Discursive, theoretical.

Google Style Guide Highlights

  • Voice: Active, not passive. ("Click the button", not "The button should be clicked").
  • Second Person: Speak to "you" (the user).
  • Simplicity: Use short sentences and plain language.

Resource Files

TopicFile
Framework Deep Divediataxis.md (Understanding the 4 types)
README Standardreadme-template.md (The Gold Standard)
Style Checkliststyle-guide.md (Writing rules)
canvas-designanthropics/skillsCreate beautiful visual art in .png and .pdf documents using design philosophy. You should use this skill when the user asks to create a poster, piece of art, design, or other static piece. Create original visual designs, never copying existing artists' work to avoid copyright violations.Stars: 196kUpdated Claude CodeCodexVerifiedInstall
docxanthropics/skillsUse this skill whenever the user wants to create, read, edit, or manipulate Word documents (.docx files) or Word templates (.dotx files). Triggers include: any mention of 'Word doc', 'word document', '.docx', '.dotx', or requests to produce professional documents with formatting like tables of contents, headings, page numbers, or letterheads. Also use when extracting or reorganizing content from .docx or .dotx files, inserting or replacing images in documents, performing find-and-replace in Word files, working with tracked changes or comments, or converting content into a polished Word document. If the user asks for a 'report', 'memo', 'letter', 'template', or similar deliverable as a Word or .docx file, use this skill. Do NOT use for PDFs, spreadsheets, Google Docs, or general coding tasks unrelated to document generation.Stars: 196kUpdated Claude CodeCodexVerifiedInstall
pdfanthropics/skillsUse this skill whenever the user wants to do anything with PDF files. This includes reading or extracting text/tables from PDFs, combining or merging multiple PDFs into one, splitting PDFs apart, rotating pages, adding watermarks, creating new PDFs, filling PDF forms, encrypting/decrypting PDFs, extracting images, and OCR on scanned PDFs to make them searchable. If the user mentions a .pdf file or asks to produce one, use this skill.Stars: 196kUpdated Claude CodeCodexVerifiedInstall
pptxanthropics/skillsUse this skill any time a .pptx or .potx file is involved in any way — as input, output, or both. This includes: creating slide decks, pitch decks, or presentations; reading, parsing, or extracting text from any .pptx or .potx file (even if the extracted content will be used elsewhere, like in an email or summary); editing, modifying, or updating existing presentations; combining or splitting slide files; working with templates (.potx), layouts, speaker notes, or comments. Trigger whenever the user mentions "deck," "slides," "presentation," or references a .pptx or .potx filename, regardless of what they plan to do with the content afterward. If a .pptx or .potx file needs to be opened, created, or touched, use this skill.Stars: 196kUpdated Claude CodeCodexVerifiedInstall