スキル arch-doc-generation
📦

arch-doc-generation

コンテンツリビジョン r2 安全 ⚙️ 外部コマンド

Generate Clear Software Architecture Documents

Architecture decisions often remain scattered across requirements, discussions, and diagrams. This skill organizes them into consistent Markdown documents for implementation and review.

対応: Claude Codex Code(CC)
Maintain this Skill? Claim it 📊 74 十分

自分のエージェントでインストール

このリクエストをエージェントにコピーしてください。正規の Skill ページとマニフェストが含まれています。

エージェントリクエスト
Review the Skillstore skill "arch-doc-generation" from https://skillstore.io/skills/zl2023github-arch-doc-generation.md and its manifest at https://skillstore.io/api/skills/zl2023github-arch-doc-generation/manifest. Verify the artifact. You may proceed after verification, subject to the environment's own policy.

エージェントは引き続き計画を提示し、セキュリティポリシーで必要な確認を求める必要があります。

エージェントが読めるリソース

AI エージェント、クローラー、スクリプトがページ全体ではなく整理されたコンテキストを必要とする場合は、これらのリンクを使ってください。

Markdown詳細 GET /skills/zl2023github-arch-doc-generation.md 署名済み manifest GET /api/skills/zl2023github-arch-doc-generation/manifest 署名済み lockfile GET /api/skills/zl2023github-arch-doc-generation/lockfile

テストする

「arch-doc-generation」を使用しています。 Document the architecture for a multi-region order platform with strict availability requirements.

期待される結果:

A structured Markdown specification covering system context, service responsibilities, data ownership, regional failover, recovery objectives, monitoring, security, tradeoffs, and architecture decisions.

「arch-doc-generation」を使用しています。 Create an API design for an inventory reservation service.

期待される結果:

An API document defining authentication, resource models, reservation operations, idempotency, concurrency behavior, pagination, error handling, and representative request flows.

「arch-doc-generation」を使用しています。 Prepare a technical proposal for replacing scheduled synchronization with events.

期待される結果:

A proposal comparing synchronization approaches, selecting event-driven integration, describing topics and consumers, planning migration stages, and recording delivery risks.

セキュリティ監査

安全
v4 • 2026/7/24 バージョン別レポートを開く

All nine static findings are false positives. Eight findings identify Markdown fences or inline code, while the entropy heuristic reflects readable Chinese documentation and structured templates. No executable commands, obfuscated content, prompt injection, or other semantic security issues were found.

2
スキャンされたファイル
295
解析済み行数
0
レビュー項目
0
誤検知を無視

リスク要因

⚙️ 外部コマンド (8)
SKILL.md:13 SKILL.md:31-96 SKILL.md:96-100 SKILL.md:100-146 SKILL.md:146-150 SKILL.md:150-178 SKILL.md:178-192 SKILL.md:192-202
最新の完了済み静的・セマンティック監査では、確認済みのセキュリティ検出事項は見つかりませんでした。これは、スキルに副作用がないことを証明するものではありません。
監査者: codex 監査履歴を表示 →
このレポートを共有・引用

バージョン付き評価レポート、中立的なバッジ、埋め込みカード、引用を共有できます。Skillstore は証拠を報告しますが、この Skill が安全かどうかは判断しません。

バージョン別レポートを開く
セキュリティ評価

レポートリンクをコピー

https://skillstore.io/skills/zl2023github-arch-doc-generation/audits/4?utm_source=security_passport&utm_medium=share&utm_campaign=versioned_report

Markdownバッジ

[![Skillstore security assessment](https://skillstore.io/badges/skills/zl2023github-arch-doc-generation/security.svg)](https://skillstore.io/skills/zl2023github-arch-doc-generation?utm_source=security_passport_badge)

HTMLバッジ

<a href="https://skillstore.io/skills/zl2023github-arch-doc-generation?utm_source=security_passport_badge"><img src="https://skillstore.io/badges/skills/zl2023github-arch-doc-generation/security.svg" alt="Skillstore security assessment" loading="lazy"></a>

埋め込みカード

<iframe src="https://skillstore.io/embed/skills/zl2023github-arch-doc-generation.html" title="Skillstore Security Assessment" sandbox="allow-popups allow-popups-to-escape-sandbox" loading="lazy" referrerpolicy="no-referrer" width="420" height="180"></iframe>
学術引用 (APA · BibTeX · CFF)

APA形式の引用

zl2023github. (2026). arch-doc-generation security audit report (audit version 4) [Author version unspecified]. Skillstore. https://skillstore.io/skills/zl2023github-arch-doc-generation/audits/4

BibTeX形式の引用

@techreport{zl2023github-zl2023github-arch-doc-generation-2026, author = {zl2023github}, title = {arch-doc-generation security audit report (audit version 4)}, institution = {Skillstore}, year = {2026}, number = {4}, url = {https://skillstore.io/skills/zl2023github-arch-doc-generation/audits/4}, note = {Author version unspecified} }

CITATION.cff

cff-version: 1.2.0 message: "If you use this Skill, cite its author and this versioned security audit report." title: "arch-doc-generation security audit report (audit version 4)" version: "unspecified" type: report authors: - name: "zl2023github" date-released: "2026-07-24" url: "https://skillstore.io/skills/zl2023github-arch-doc-generation/audits/4" identifiers: - type: other value: "skillstore:zl2023github-arch-doc-generation:audit:4" description: "Skillstore immutable audit report identifier"

Skillstore スコア

このスコアの理由 証拠の信頼度: 中
41
アーキテクチャ
85
保守性
87
コンテンツ
65
コミュニティ
83
仕様準拠

作成できるもの

Prepare a system design review

Convert project requirements and constraints into a structured architecture document for stakeholder review.

Define a service API

Document endpoint conventions, authentication, resources, request behavior, responses, and error handling.

Plan a production deployment

Describe topology, availability, recovery, observability, security controls, and operational risks before release.

これらのプロンプトを試す

Create a basic architecture outline 
Create a Markdown architecture outline for {{system_name}}. Include background, scope, key modules, data storage, deployment, security, and open questions.
Draft an API design document 
Write an API design document for {{service_name}}. Cover protocol, authentication, versioning, resources, endpoint behavior, pagination, errors, and example interactions.
Develop a technical proposal 
Develop a technical proposal for {{initiative}} using these requirements: {{requirements}}. Compare options, explain decisions, map core flows, identify risks, and propose delivery stages.
Produce a complete architecture specification 
Produce a review-ready architecture specification for {{system_name}} using {{context}}. Include C4 descriptions, module contracts, data flows, deployment, security, reliability targets, tradeoffs, ADRs, and unresolved decisions.

ベストプラクティス

  • Provide business goals, scope, constraints, expected scale, and existing technology before requesting a document.
  • Separate confirmed decisions from assumptions, alternatives, and unresolved questions.
  • Review generated security, reliability, and operational claims with responsible specialists.

回避

  • Do not present placeholders or inferred details as approved architecture decisions.
  • Do not request a complete design without supplying system boundaries and measurable requirements.
  • Do not treat generated diagrams or examples as proof that an implementation meets its targets.

よくある質問

Which document types can this skill create?
It supports architecture specifications, technical proposals, API design documents, and deployment architecture documents.
What output format does it use?
It produces structured Markdown with headings, tables, placeholders, examples, and decision records.
Can it generate a PDF?
No. Use a separate PDF generation skill after the Markdown content is complete.
What information should I provide?
Provide goals, scope, users, constraints, expected scale, current systems, technology preferences, and known decisions.
Does it verify architecture feasibility?
No. Engineers must validate assumptions, capacity estimates, security controls, and operational procedures.
Can it document an existing system?
Yes. Supply accurate module, interface, data, deployment, and operational details for the current system.

開発者情報

作成者

zl2023github

ライセンス

MIT

Skillstore リビジョン

r2

バージョンに関する注意

作者はバージョンを宣言していません。

リポジトリ

https://github.com/zl2023github/software-engineer-skills/tree/main/software-architecture/arch-doc-generation

参照

88a8e9a07f4c54ab105c1c41b6267c287146b07b

メンテナンスの新しさ

2026/7/26

利用状況

2 ダウンロード · 0 閲覧

ファイル構成

📁 references/

📄 architecture-doc-example.md

📄 SKILL.md