github/awesome-copilot

documentation-writer

Diátaxis Documentation Expert.

ソースを見る

使い方

  1. インストールコマンドをコピーし、自分の環境へ導入する前にソースを確認します。
  2. 必要なツール、認証情報、対応環境を原文で確認します。
  3. 入力と成果物を指定し、出力を資料と照合します。
npx skills add https://github.com/github/awesome-copilot --skill documentation-writer

開始前の確認

  • 導入にはモデル契約、API枠、ファイルへのアクセス許可は含まれません。
  • スター数や導入数は活動の指標であり、独立した品質・安全性試験ではありません。
リポジトリの原文

見出し、例、コード、表、リンク、参照画像を含む原文を表示しています。

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

  1. Clarity: Write in simple, clear, and unambiguous language.
  2. Accuracy: Ensure all information, especially code snippets and technical details, is correct and up-to-date.
  3. User-Centricity: Always prioritize the user's goal. Every document must help a specific user achieve a specific task.
  4. 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:

  1. 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?
  1. 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.
  1. 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.

タスクに関連する項目

同じリポジトリから

関連する Skills

すべての Skills
github
公式

anti-ui-slop

Stop coding agents from shipping generic UI. Use UIZZE''s 800,000+ real web and iOS screens to build product-specific interfaces, define a design contract, cover required states, and run a hard finish gate. Use when designing, implementing, redesigning, critiquing, or pre-ship reviewing a web or iOS interface in Codex, Claude Code, Cursor, Copilot, or another coding agent. Trigger with "anti-ui-slop", "stop UI slop", "ground this UI in real screens", or "run the UI finish gate".

1時間の導入数
7
GitHub Stars
4.1万
更新日
11月20日
github
公式

javascript-typescript-jest

Best practices for writing JavaScript/TypeScript tests using Jest, including mocking strategies, test structure, and common patterns.

1時間の導入数
4
GitHub Stars
4.1万
更新日
11月20日
github
公式

multi-stage-dockerfile

Create optimized multi-stage Dockerfiles for any language or framework

24時間の導入数
446
GitHub Stars
4.1万
更新日
11月20日
github
公式

sql-code-review

Universal SQL code review assistant that performs comprehensive security, maintainability, and code quality analysis across all SQL databases (MySQL, PostgreSQL, SQL Server, Oracle). Focuses on SQL injection prevention, access control, code standards, and anti-pattern detection. Complements SQL optimization prompt for complete development coverage.

24時間の導入数
437
GitHub Stars
4.1万
更新日
11月20日