跳转到主要内容
此内容尚未提供您的语言版本,正在以英文显示。

Technical Documentation Creator

技能 活跃

Create HTML technical documentation with code blocks, API workflows, system architecture diagrams, and syntax highlighting. Use when users request technical documentation, API docs, API references, code examples, or developer documentation.

目的

To automate the creation of professional-looking HTML technical documentation, making it easier to generate API references, code examples, and system overviews.

功能

  • Generate HTML technical documentation
  • Include code blocks with syntax highlighting
  • Create API workflows and references
  • Incorporate system architecture diagrams (SVG)
  • Utilize modern UI design patterns and color scales

使用场景

  • When users request technical documentation for a project
  • When users need API documentation or API references
  • When users ask for code examples or developer documentation
  • When users require system architecture diagrams

非目标

  • Generating documentation in formats other than HTML
  • Automating code refactoring or testing
  • Providing real-time API interaction

工作流

  1. Extract API endpoints, methods, and parameters.
  2. Create overview and getting started sections.
  3. Document each endpoint with examples.
  4. Add code snippets for common operations.
  5. Include architecture diagram if relevant.
  6. Write to '[system]-docs.html'.

Trust

  • warning:Issues AttentionIn the last 90 days, 6 issues were opened and 0 were closed, indicating slow or no response from maintainers to reported issues.

Practical Utility

  • info:Usage examplesWhile the skill description lists usage examples, the SKILL.md file does not contain specific ready-to-use end-to-end examples demonstrating invocation and output.

安装

请先添加 Marketplace

/plugin marketplace add mhattingpete/claude-skills-marketplace
/plugin install visual-documentation-plugin@mhattingpete-claude-skills

质量评分

79 /100
1 day ago 分析

信任信号

最近提交2 months ago
星标574
许可证Apache-2.0
状态
查看源代码

类似扩展