arch-doc-generation
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.
Install with my Agent
Copy this request to your Agent. It includes the canonical Skill page and manifest.
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.Your Agent should still show its plan and request any confirmation required by the security policy.
Agent-readable resources
Use these links when an AI agent, crawler, or script needs clean context instead of reading the full page.
Test it
Using "arch-doc-generation". Document the architecture for a multi-region order platform with strict availability requirements.
Expected outcome:
A structured Markdown specification covering system context, service responsibilities, data ownership, regional failover, recovery objectives, monitoring, security, tradeoffs, and architecture decisions.
Using "arch-doc-generation". Create an API design for an inventory reservation service.
Expected outcome:
An API document defining authentication, resource models, reservation operations, idempotency, concurrency behavior, pagination, error handling, and representative request flows.
Using "arch-doc-generation". Prepare a technical proposal for replacing scheduled synchronization with events.
Expected outcome:
A proposal comparing synchronization approaches, selecting event-driven integration, describing topics and consumers, planning migration stages, and recording delivery risks.
Security Audit
SafeAll 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.
Risk Factors
⚙️ External commands (8)
Share & cite this report
Share the versioned assessment report, neutral badge, embed card, and citations. Skillstore reports evidence without deciding whether this Skill is safe.
Copy report link
https://skillstore.io/skills/zl2023github-arch-doc-generation/audits/4?utm_source=security_passport&utm_medium=share&utm_campaign=versioned_reportMarkdown badge
[](https://skillstore.io/skills/zl2023github-arch-doc-generation?utm_source=security_passport_badge)HTML badge
<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>Embed card
<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>Academic citations (APA · BibTeX · CFF)
APA citation
zl2023github. (2026). arch-doc-generation security audit report (audit version 4) [Author version unspecified]. Skillstore. https://skillstore.io/skills/zl2023github-arch-doc-generation/audits/4BibTeX citation
@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 Score
Why this score Evidence Confidence: MediumWhat You Can Build
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.
Try These Prompts
Create a Markdown architecture outline for {{system_name}}. Include background, scope, key modules, data storage, deployment, security, and open questions.Write an API design document for {{service_name}}. Cover protocol, authentication, versioning, resources, endpoint behavior, pagination, errors, and example interactions.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 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.Best Practices
- 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.
Avoid
- 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.
Frequently Asked Questions
Which document types can this skill create?
What output format does it use?
Can it generate a PDF?
What information should I provide?
Does it verify architecture feasibility?
Can it document an existing system?
Developer Details
Author
zl2023githubLicense
MIT
Skillstore revision
r2
Version notice
The author did not declare a version.
Ref
88a8e9a07f4c54ab105c1c41b6267c287146b07b
Maintenance freshness
7/26/2026
Usage
2 downloads · 0 views
File structure