Skills docs-architect
📦

docs-architect

Content revision r1 Safe ⚙️ External commands

Build Definitive Technical Documentation

Complex codebases hide architecture and design rationale. This skill turns repository evidence into structured, audience-aware technical documentation.

Supports: Claude Codex Code(CC)
🥉 78 Bronze

Install with my Agent

Copy this request to your Agent. It includes the canonical Skill page and manifest.

Agent request
Review the Skillstore skill "docs-architect" from https://skillstore.io/skills/sickn33-docs-architect.md and its manifest at https://skillstore.io/api/skills/sickn33-docs-architect/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 "docs-architect". Document the payment service for new backend engineers.

Expected outcome:

  • Executive summary describing the service purpose and system boundary.
  • Component map covering handlers, business logic, storage, and external providers.
  • Request flow describing validation, authorization, payment processing, persistence, and failure handling.
  • Operational notes covering configuration, observability, retries, and known risks.

Using "docs-architect". Prepare an architecture review for the event processing platform.

Expected outcome:

  • Architecture overview identifying producers, brokers, consumers, storage, and external integrations.
  • Sequence descriptions for normal processing, retries, dead-letter handling, and replay.
  • Decision record summarizing delivery guarantees, scaling choices, failure modes, and security boundaries.

Using "docs-architect". Create a long-term maintenance guide for a legacy application.

Expected outcome:

  • Module inventory with ownership, responsibilities, dependencies, and change risk.
  • Data model and integration reference grounded in current source files.
  • Troubleshooting guide covering common failures, diagnostic evidence, and escalation points.
  • Appendix listing terminology, assumptions, unresolved questions, and recommended documentation updates.

Security Audit

Safe
v5 • 7/23/2026 Open versioned report

The single static finding is a false positive: SKILL.md line 24 uses Markdown backticks around a resource path, not shell execution. The skill contains instructions only and defines no executable behavior. No prompt injection or other intent-based security issue was found.

1
Files scanned
102
Lines analyzed
0
Review items
0
False positives ignored

Risk Factors

⚙️ External commands (1)
No confirmed security findings were detected by the latest completed static and semantic audit. This does not prove the skill has no side effects.
Audited by: codex View Audit History →
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.

Open versioned report
Security Assessment

Copy report link

https://skillstore.io/skills/sickn33-docs-architect/audits/5?utm_source=security_passport&utm_medium=share&utm_campaign=versioned_report

Markdown badge

[![Skillstore security assessment](https://skillstore.io/badges/skills/sickn33-docs-architect/security.svg)](https://skillstore.io/skills/sickn33-docs-architect?utm_source=security_passport_badge)

HTML badge

<a href="https://skillstore.io/skills/sickn33-docs-architect?utm_source=security_passport_badge"><img src="https://skillstore.io/badges/skills/sickn33-docs-architect/security.svg" alt="Skillstore security assessment" loading="lazy"></a>

Embed card

<iframe src="https://skillstore.io/embed/skills/sickn33-docs-architect.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

sickn33. (2026). docs-architect security audit report (audit version 5) [Author version unspecified]. Skillstore. https://skillstore.io/skills/sickn33-docs-architect/audits/5

BibTeX citation

@techreport{sickn33-sickn33-docs-architect-2026, author = {sickn33}, title = {docs-architect security audit report (audit version 5)}, institution = {Skillstore}, year = {2026}, number = {5}, url = {https://skillstore.io/skills/sickn33-docs-architect/audits/5}, 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: "docs-architect security audit report (audit version 5)" version: "unspecified" type: report authors: - name: "sickn33" date-released: "2026-07-23" url: "https://skillstore.io/skills/sickn33-docs-architect/audits/5" identifiers: - type: other value: "skillstore:sickn33-docs-architect:audit:5" description: "Skillstore immutable audit report identifier"

Skillstore Score

Why this score Evidence Confidence: High
55
Architecture
85
Maintainability
87
Content
69
Community
83
Spec Compliance

What You Can Build

Accelerate Developer Onboarding

Create a guided system overview with component responsibilities, data flows, local setup context, and focused reading paths.

Prepare Architecture Reviews

Document system boundaries, integration points, design decisions, security controls, performance characteristics, and operational tradeoffs.

Preserve System Knowledge

Turn implementation details and historical decisions into a maintainable reference for future changes and incident analysis.

Try These Prompts

Document One Component
Analyze [component path]. Create a Markdown overview covering purpose, responsibilities, dependencies, public interfaces, and one concrete usage example. Cite relevant files and line numbers.
Create an Onboarding Guide
Analyze [repository scope] for new [role] team members. Explain the system overview, key workflows, important modules, terminology, and a recommended reading path. Cite repository evidence.
Map the System Architecture
Document the architecture of [system scope]. Cover boundaries, components, dependencies, data flows, integrations, deployment, security, and performance. Describe suitable architecture and sequence diagrams.
Produce a Technical Manual
Create a staged technical manual for [repository]. Define the chapter plan first, then document each approved section with citations. Reconcile terminology, cross-references, assumptions, and unresolved questions.

Best Practices

  • Provide repository scope, target audience, desired depth, and required output format before analysis begins.
  • Require every technical claim to cite current files and line numbers.
  • Generate large manuals in reviewed sections, then reconcile terminology and cross-references.

Avoid

  • Do not request a definitive architecture guide from incomplete or outdated source material.
  • Do not accept inferred behavior as fact when repository evidence is missing.
  • Do not combine every audience into one undifferentiated document.

Frequently Asked Questions

What inputs should I provide?
Provide repository access, scope boundaries, target readers, desired depth, and any existing architecture records.
Does this skill execute or test code?
No. It guides codebase analysis and documentation generation but does not run, test, or deploy software.
Which output format does it use?
It is designed for structured Markdown with headings, tables, examples, cross-references, and detailed diagram descriptions.
Can it create architecture diagrams?
It can plan and describe architecture, sequence, and flow diagrams. Rendering depends on the tools available in your environment.
How should I verify the documentation?
Review citations against current source files, test operational claims separately, and ask subject matter experts to confirm design rationale.
Can it document a large repository?
Yes, but large repositories should be documented in stages with explicit scope and a final consistency review.

Developer Details

Author

sickn33

License

MIT

Skillstore revision

r1

Version notice

The author did not declare a version.

Ref

f9e2c34b4f19c7f3e6b0a1e93227b5f77cc12526

Maintenance freshness

7/26/2026

Usage

8 downloads · 104 views

File structure

📄 SKILL.md