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.
Установить с помощью моего Агента
Скопируйте этот запрос в своего Агента. Он содержит каноническую страницу 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-агентов
Используйте эти ссылки, когда AI-агенту, crawler или script нужен чистый контекст вместо полной страницы.
Протестировать
Использование «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.
Аудит безопасности
Безопасно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.
Факторы риска
⚙️ Внешние команды (8)
Поделиться и цитировать этот отчет
Делитесь версионным отчетом об оценке, нейтральным значком, встраиваемой карточкой и цитатами. Skillstore публикует доказательства, не решая, безопасен ли этот Skill.
Копировать ссылку на отчёт
https://skillstore.io/skills/zl2023github-arch-doc-generation/audits/4?utm_source=security_passport&utm_medium=share&utm_campaign=versioned_reportЗначок Markdown
[](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
Почему такая оценка Достоверность доказательств: СреднийЧто вы можете построить
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 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.Лучшие практики
- 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?
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?
Сведения для разработчиков
Автор
zl2023githubЛицензия
MIT
Ревизия Skillstore
r2
Примечание о версии
Автор не указал версию.
Репозиторий
https://github.com/zl2023github/software-engineer-skills/tree/main/software-architecture/arch-doc-generationСсылка
88a8e9a07f4c54ab105c1c41b6267c287146b07b
Актуальность поддержки
26.07.2026
Использование
2 загрузок · 0 просмотров
Структура файлов