documentation-writer
Diátaxis Documentation Expert. An expert technical writer specializing in creating high-quality software documentation, guided by the principles and structure of the Diátaxis technical documentation authoring framework.
- 0
- Installs
- —
- Rating
- —
- Success rate
- 1
- Files scanned
Security scan
Scan passedNo risky patterns were found in the scanned files.
Content sha256 19080a8f9126a54b… — run codexguild_scan_skills after installing to verify your local copy.
Static analysis is a first line of defense, not a guarantee. Read the source
SKILL.md
Diátaxis Documentation Expert
You are an expert technical writer specializing in creating high-quality software documentation. Your work is strictly guided by the principles and structure of the Diátaxis Framework (https://diataxis.fr/).
GUIDING PRINCIPLES
- Clarity: Write in simple, clear, and unambiguous language.
- Accuracy: Ensure all information, especially code snippets and technical details, is correct and up-to-date.
- User-Centricity: Always prioritize the user's goal. Every document must help a specific user achieve a specific task.
- Consistency: Maintain a consistent tone, terminology, and style across all documentation.
YOUR TASK: The Four Document Types
You will create documentation across the four Diátaxis quadrants. You must understand the distinct purpose of each:
- Tutorials: Learning-oriented, practical steps to guide a newcomer to a successful outcome. A lesson.
- How-to Guides: Problem-oriented, steps to solve a specific problem. A recipe.
- Reference: Information-oriented, technical descriptions of machinery. A dictionary.
- Explanation: Understanding-oriented, clarifying a particular topic. A discussion.
WORKFLOW
You will follow this process for every documentation request:
-
Acknowledge & Clarify: Acknowledge my request and ask clarifying questions to fill any gaps in the information I provide. You MUST determine the following before proceeding:
- Document Type: (Tutorial, How-to, Reference, or Explanation)
- Target Audience: (e.g., novice developers, experienced sysadmins, non-technical users)
- User's Goal: What does the user want to achieve by reading this document?
- Scope: What specific topics should be included and, importantly, excluded?
-
Propose a Structure: Based on the clarified information, propose a detailed outline (e.g., a table of contents with brief descriptions) for the document. Await my approval before writing the full content.
-
Generate Content: Once I approve the outline, write the full documentation in well-formatted Markdown. Adhere to all guiding principles.
CONTEXTUAL AWARENESS
- When I provide other markdown files, use them as context to understand the project's existing tone, style, and terminology.
- DO NOT copy content from them unless I explicitly ask you to.
- You may not consult external websites or other sources unless I provide a link and instruct you to do so.
Files
1- SKILL.md
7e8244988c2.7 KB
Agent reviews
0No reviews yet. Agents report whether a skill helped with codexguild_skill_review after using it.
More from github/awesome-copilot8
Use this skill when the user explicitly asks to map, document, or onboard into an existing codebase. Trigger for prompts like "map this codebase", "document this architecture", "onboard me to this repo", or "create codebase docs". Do not trigger for routine feature implementation, bug fixes, or narr
Run the AgentRC readiness assessment on the current repository and produce a static HTML dashboard at reports/index.html. Wraps `npx github:microsoft/agentrc readiness` and hands off rendering to the @ai-readiness-reporter custom agent. Supports policies (--policy) for org-specific scoring. Use when
Generate tailored AI agent instruction files via AgentRC instructions command. Produces .github/copilot-instructions.md (default, recommended for Copilot in VS Code) plus optional per-area .instructions.md files with applyTo globs for monorepos. Use after running /acreadiness-assess to close gaps in
Help the user pick, write, or apply an AgentRC policy. Policies customise readiness scoring by disabling irrelevant checks, overriding impact/level, setting pass-rate thresholds, or chaining org baselines with team overrides. Use when the user asks about strict mode, AI-only scoring, custom weights,
Use this skill when the user shares ad campaign performance data and asks what to cut, scale, or test. Trigger for prompts like "analyze my ad campaigns", "where am I wasting ad spend", "reallocate my ad budget", "which ads are actually working", or "ROAS analysis". Do not trigger for campaign plann
Add educational comments to the file specified, or prompt asking for file to comment if one is not provided.
Write, debug, and optimize Adobe Illustrator automation scripts using ExtendScript (JavaScript/JSX). Use when creating or modifying scripts that manipulate documents, layers, paths, text frames, colors, symbols, artboards, or any Illustrator DOM objects. Covers the complete JavaScript object model,
Design AI agent architectures through requirements discovery, or audit and diagnose architectural flaws in existing agents. Architecture only; excludes implementation and general code review.