スキル一覧に戻る
Row0902

write-documentation

by Row0902

0🍴 0📅 2026年1月21日
GitHubで見るManusで実行

SKILL.md


name: Write Documentation description: Diátaxis framework templates and rules for creating documentation in English.

📝 Documentation Skill (Diátaxis)

Context

All documentation must be in English and follow the Diátaxis framework.

1. Architecture Reference (File: docs/reference/module_name.md)

# Reference: [Module Name]

> **Type:** Technical Reference
> **Audience:** Developers

Brief description of what this module provides.

## ⚙️ API Usage

::: package.module_name
    options:
      show_root_heading: true
      show_source: false

2. How-To Guide (File: docs/guides/how_to_task.md)

# How-to: [Action Name]

> **Type:** Guide
> **Goal:** [Specific goal]

## 🪜 Prerequisites
*   [ ] Requirement 1
*   [ ] Requirement 2

## 🚀 Steps

1.  **Step One:**
    Arguments or commands to run.
    
    ```python
    # Example code
    ```

2.  **Step Two:**
    Description.

3. Explanation/Concept (File: docs/topics/concept_name.md)

# Concept: [Topic Name]

> **Type:** Explanation

Deep dive into *why* something works the way it does. Not instructions, but understanding.

Checklist

  • English Only?
  • Absolute Paths for Images?
  • Correct Directory? (docs/reference, docs/guides, etc.)

スコア

総合スコア

35/100

リポジトリの品質指標に基づく評価

SKILL.md

SKILL.mdファイルが含まれている

+20
LICENSE

ライセンスが設定されている

0/10
説明文

100文字以上の説明がある

0/10
人気

GitHub Stars 100以上

0/15
最近の活動

3ヶ月以内に更新がある

0/10
フォーク

10回以上フォークされている

0/5
Issue管理

オープンIssueが50未満

+5
言語

プログラミング言語が設定されている

0/5
タグ

1つ以上のタグが設定されている

0/5

レビュー

💬

レビュー機能は近日公開予定です