{"id":"spillwavesolutions-document-specialist-skill","name":"document-specialist-skill","homepage":null,"repo_url":"https://github.com/SpillwaveSolutions/document-specialist-skill","category":"devtools","subcategories":[],"tags":["documentation","claude-code-skill","docx","pdf","openapi","srs","prds","arc42","diagrams","mermaid","plantuml","agentic-skill","pda"],"what_it_does":"A Claude Code “skill” that generates, audits, and converts software documentation. It supports greenfield template-based documents (e.g., SRS/PRD/SDD/OpenAPI/user guides), brownfield reverse-engineering for certain frameworks (notably Spring Boot and Pulumi), documentation audits with gap analysis/checklists, and diagram generation (via other skills). It also uses a “Progressive Disclosure Architecture (PDA)” approach described as loading only the core routing content by default and pulling workflow/templates on demand.","use_cases":["Generate IEEE-style SRS, PRD, and arc42/SDD-style design docs from a project description","Extract documentation artifacts from a Spring Boot codebase (OpenAPI, diagrams, ER diagrams)","Create API documentation packages and audit them for quality gaps/best-practices","Audit existing documentation for completeness and provide improvement recommendations","Convert generated Markdown docs into DOCX and/or PDF","Generate architecture diagrams (C4, Mermaid/PlantUML) for system documentation","Produce documentation sets for compliance-oriented teams (e.g., audit-ready documentation workflows)"],"not_for":["Implementing or running production software services/APIs","Providing verified legal/compliance attestations (it’s documentation generation/auditing, not compliance certification)","Acting as a secure credential vault or key-management solution","Fully supporting every framework/technology listed as “planned” without additional work"],"best_when":"You want documentation that’s consistent with established templates/styles (SRS/PRD/SDD/OpenAPI) and you’re working within the skill’s supported ecosystems (especially Spring Boot and Pulumi), with optional diagram/format conversion via companion skills.","avoid_when":"You need a strict, deterministic documentation extractor for arbitrary languages/frameworks not covered by existing mappings (e.g., the README marks many as planned). Also avoid using it when you cannot tolerate potential hallucinations/generic sections from an LLM-style generation workflow.","alternatives":["Other doc-generation tools (e.g., Swagger/OpenAPI tooling plus human-written design docs)","Documentation-as-code approaches (e.g., Sphinx/DocFX + templates)","OpenAPI generator / code-first documentation frameworks","Static analysis tools for architecture/ER diagram extraction (where available)","General-purpose LLM prompting without a packaged skill (with your own templates and review workflow)"],"af_score":36.2,"security_score":10.5,"reliability_score":23.8,"package_type":"skill","discovery_source":["openclaw"],"priority":"high","status":"evaluated","version_evaluated":null,"last_evaluated":"2026-03-30T15:37:06.977119+00:00","interface":{"has_rest_api":false,"has_graphql":false,"has_grpc":false,"has_mcp_server":false,"mcp_server_url":null,"has_sdk":false,"sdk_languages":[],"openapi_spec_url":null,"webhooks":false},"auth":{"methods":[],"oauth":false,"scopes":false,"notes":"No authentication mechanism is described. This appears to be a local/skills-based Claude Code extension that runs within the Claude Code environment."},"pricing":{"model":null,"free_tier_exists":false,"free_tier_limits":null,"paid_tiers":[],"requires_credit_card":false,"estimated_workload_costs":null,"notes":"README only mentions installation via a marketplace; no pricing, tiers, or usage limits are provided in the available content."},"requirements":{"requires_signup":false,"requires_credit_card":false,"domain_verification":false,"data_residency":[],"compliance":[],"min_contract":null},"agent_readiness":{"af_score":36.2,"security_score":10.5,"reliability_score":23.8,"mcp_server_quality":0.0,"documentation_accuracy":35.0,"error_message_quality":0.0,"error_message_notes":null,"auth_complexity":100.0,"rate_limit_clarity":0.0,"tls_enforcement":0.0,"auth_strength":0.0,"scope_granularity":0.0,"dependency_hygiene":30.0,"secret_handling":30.0,"security_notes":"No transport/security model, auth, or secret-handling guarantees are stated in the provided content. Because it generates documentation from code and may integrate other skills, the main risk is data exposure to the LLM provider/environment (not specified here) and potential leakage of sensitive code/docs into generated outputs. Dependency hygiene can’t be verified from README alone; a modest score is used due to lack of evidence.","uptime_documented":0.0,"version_stability":45.0,"breaking_changes_history":20.0,"error_recovery":30.0,"idempotency_support":"false","idempotency_notes":null,"pagination_style":"none","retry_guidance_documented":false,"known_agent_gotchas":["Skill is framed as LLM-driven generation/extraction; results may be generic if inputs lack sufficient context.","Some framework mappings are labeled “Planned” rather than implemented; detection/extraction may fail or fall back to generic templates.","Diagram/format conversion depends on other skills being installed (mermaid-architect, plantuml, docx, pdf).","No concrete contract/interface (e.g., JSON schemas, tool signatures) is described in the README; integration is likely prompt/command driven rather than API-contract driven."]}}