home / skills / ntaksh42 / agents / azure-wiki-generator

azure-wiki-generator skill

safe

This skill helps you generate and manage Azure DevOps Wiki pages with markdown content, including automatic TOCs and embedded diagrams for clear project

npx playbooks add skill ntaksh42/agents --skill azure-wiki-generator

Review the files below or copy the command above to add this skill to your agents.

Files (1)

SKILL.md

2.5 KB

---
name: azure-wiki-generator
description: Generate and manage Azure DevOps Wiki pages with markdown content. Use when creating project documentation or wiki pages.
---

# Azure Wiki Generator Skill

Azure DevOps Wikiページを生成するスキルです。

## 主な機能

- **Wikiページ作成**: Markdown形式
- **目次生成**: 階層構造
- **ドキュメントテンプレート**: プロジェクトドキュメント
- **図表埋め込み**: Mermaid、画像

## Wikiページ作成

### ホームページ

```markdown
# プロジェクトWiki

## 概要

このWikiにはプロジェクトのドキュメントが含まれています。

## 目次

- [アーキテクチャ](Architecture)
- [開発ガイド](Development-Guide)
- [デプロイメント](Deployment)
- [API仕様](API-Reference)

## クイックスタート

1. [環境セットアップ](Setup)
2. [ローカル開発](Local-Development)
3. [テスト実行](Testing)
```

### アーキテクチャページ

```markdown
# システムアーキテクチャ

## 概要図

```mermaid
graph TB
    Client[クライアント] --> LB[ロードバランサー]
    LB --> Web1[Webサーバー1]
    LB --> Web2[Webサーバー2]
    Web1 --> DB[(データベース)]
    Web2 --> DB
    Web1 --> Cache[Redis]
    Web2 --> Cache
```

## コンポーネント

### フロントエンド
- React 18
- TypeScript
- Tailwind CSS

### バックエンド
- Node.js + Express
- PostgreSQL
- Redis

### インフラ
- Azure App Service
- Azure Database for PostgreSQL
- Azure Cache for Redis
```

## Git操作でWiki更新

```bash
# Wikiリポジトリのクローン
git clone https://dev.azure.com/myorg/MyProject/_git/MyProject.wiki

cd MyProject.wiki

# 新ページ作成
cat > API-Reference.md << 'WIKI'
# API リファレンス

## エンドポイント

### GET /api/users
ユーザー一覧を取得

**レスポンス:**
```json
{
  "users": [
    {
      "id": 1,
      "name": "John Doe"
    }
  ]
}
```
WIKI

# コミット＆プッシュ
git add .
git commit -m "Add API Reference page"
git push
```

## ページテンプレート

### 機能仕様

```markdown
# [機能名]

## 概要
[機能の簡単な説明]

## 要件
- 要件1
- 要件2

## ユースケース
1. ユーザーが...
2. システムは...

## UI/UX
[スクリーンショットまたはモックアップ]

## 技術仕様
### データモデル
### API
### セキュリティ

## テスト計画
- [ ] ユニットテスト
- [ ] 統合テスト
- [ ] E2Eテスト
```

## バージョン情報
- Version: 1.0.0

Overview

This skill generates and manages Azure DevOps Wiki pages using Markdown to produce clear, navigable project documentation. It provides page templates, automatic table-of-contents structure, and support for diagrams (Mermaid) and embedded images. Use it to standardize documentation, bootstrap new projects, and update wiki content via Git workflows.

How this skill works

The skill creates Markdown files for home, architecture, API reference, and feature-spec pages, and can produce hierarchical table-of-contents links. It embeds Mermaid diagrams and image references in the generated pages, and outputs ready-to-commit files for the Azure DevOps Wiki Git repository. For updates, it provides Git commands and commit-ready content so pages can be pushed to the .wiki repo.

When to use it

Bootstrapping a new project wiki with standard sections and templates
Documenting system architecture with diagrams and component lists
Creating consistent API reference pages and example JSON responses
Providing feature-spec templates for product and engineering teams
Automating wiki updates via Git in CI/CD or documentation workflows

Best practices

Keep each wiki page focused and short; use templates for consistency
Use Mermaid for architecture diagrams and include alt text for accessibility
Organize pages into a clear hierarchy and update the table of contents when adding pages
Commit small, frequent documentation updates and include descriptive commit messages
Store images in the wiki repo or a central assets folder and reference them by relative path

Example use cases

Generate a Project Wiki home page with overview, quickstart, and TOC for a new repo
Create an Architecture page with a Mermaid system diagram and component breakdown
Produce an API Reference page with endpoints, example requests, and JSON responses
Use the feature-spec template to capture requirements, UI notes, data model, and test plan
Automate pushing documentation changes from CI to the Azure DevOps Wiki Git repo

FAQ

Can the skill embed diagrams and images?

Yes — it supports Mermaid diagrams and image references; include images in the wiki assets folder and reference them by relative path.

How do I update the Azure DevOps Wiki with generated pages?

Clone the project.wiki Git repo, add the generated Markdown files, commit with a clear message, and push. The skill provides the example Git commands to use.