文档编写 Skill技能列表
编写文档技能Skill writing-documentation
这个技能通过应用《风格的要素》原则,帮助用户编写和改进技术文档,如README、API文档、指南、架构文档等,以提高文档的简洁性、清晰度和可读性。关键词:技术文档、写作技巧、清晰文档、简洁写作、Elements of Style、文档优化、文档审查。
Markdown文档Skill markdown-documentation
掌握 Markdown 语法和最佳实践,用于创建格式良好、易读的文档,包括标准 Markdown 和 GitHub Flavored Markdown (GFM) 的使用。关键词:Markdown, 文档编写,技术文档,GitHub。
技术文档引擎Skill TechnicalDocumentationEngine
技术文档引擎是一个全面技术文档系统,从规划到维护,涵盖README文件、API文档、指南、架构文档、运行手册和开发者门户。包括模板、质量评分和自动化。
用户指南创建Skill user-guide-creation
创建详尽的用户指南、教程、操作指南和逐步指导文档,包含屏幕截图和示例,适用于编写用户文档、教程或入门指南。
编写文档技能Skill writing-docs
此技能激活于需要编写代码、API和项目文档的场合,提供多语言模板和最佳实践,以实现有效的文档编写。
文档编写技能Skill documentation-writer
专家技术作家,专注于为Logseq模板图项目创建清晰、准确、用户友好的文档,包括模块文档、用户指南、技术参考和API文档。
Markdown语法基础Skill markdown-syntax-fundamentals
这个技能提供了Markdown语法的全面指南,涵盖标题、文本格式化、列表、链接、图像、代码块、引用等核心元素。适用于编写和编辑Markdown文件,帮助创建结构清晰、格式规范的文档,便于SEO搜索和文档管理。关键词:Markdown语法、文档编写、文本编辑、代码块、SEO优化。
Ankane风格README文档编写器Skill ankane-readme-writer
此技能用于帮助开发者创建和更新Ruby gem的README文件,遵循Ankane风格模板,确保文档简洁、格式规范,使用命令式语音、保持句子简短、组织标准章节顺序。关键词:Ruby, README, Ankane风格, 文档编写, gem开发, 命令式语音, 代码围栏, 量化金融(不直接相关,但提及以增强SEO)
文档模板Skill documentation-templates
文档模板技能提供了编写和维护软件项目文档的标准模板和结构指南,帮助开发者快速创建高质量的文档,包括README、API文档、代码注释、更新日志、架构决策记录和AI友好型文档等。关键词:文档模板、技术文档、软件开发、API文档、代码注释、AI文档、文档结构、模板指南。