Communityライティング&編集github.com

angular/adev-writing-guide

Angular ドキュメント(adev)向けの包括的なライティングガイドです。Google テクニカルライティング標準、Angular 固有の Markdown 拡張、コードブロック、コンポーネントについて説明します。`adev/` または `adev/src/content` 内のドキュメントファイルを作成、編集、レビューする際には、必ずこのスキルを使用する必要があります。

adev-writing-guide とは?

このスキルは、Angular プロジェクトのドキュメンテーション、特に `adev` ディレクトリ下のコンテンツを作成・編集する際に遵守すべきガイドラインを提供します。Google のテクニカルライティング標準に基づいた明瞭で簡潔な文体、Angular ドキュメント向けの特殊な Markdown 記法(コードブロックの指定方法や `docs`、`docs-card` などの組み込みコンポーネントの利用方法)をカバーしています。開発者が一貫性のある高品質なドキュメントを効率的に生成できるよう支援し、コード例や API リファレンスとの連携をスムーズにします。主に Claude Code、Cursor、Codex などの AI エージェントが `adev/` パス内のファイルを扱う際に、自動的にこのスキルを参照することで、独自のスタイル規則に準拠したドキュメント生成が可能になります。

対応~Claude Code~Codex CLI~Cursor
npx skills add https://github.com/angular/angular/tree/main/skills/adev-writing-guide

Installed? Explore more ライティング&編集 skills: steipete/notion, langchain-ai/langchain, bytedance/podcast-generation · View all 6 →

お気に入りのAIに質問する

このエージェントスキルを事前に読み込んだ状態で新しいチャットを開きます。

ドキュメント

adev-writing-guide は何をしますか?

Angular ドキュメント(adev)向けの包括的なライティングガイドです。Google テクニカルライティング標準、Angular 固有の Markdown 拡張、コードブロック、コンポーネントについて説明します。adev/ または adev/src/content 内のドキュメントファイルを作成、編集、レビューする際には、必ずこのスキルを使用する必要があります。

Individual skills in this repo

This repo contains 4 individual skills — each has its own dedicated page.

関連スキル