文档编写
文档编写提供清晰、完整的Skill使用指南,帮助用户快速上手和正确使用。文档结构:README、API文档、教程;README规范:简介、安装、使用;API文档:参数、返回值、示例;教程编写:入门、进阶、最佳实践;文档工具:Sphinx、MkDocs、Docusaurus。
学习资源(16 个)
📎
Sphinx - Documentation
Sphinx文档工具
进阶
📎
MkDocs - Documentation
MkDocs文档工具
进阶
📎
百度千帆 - 技能文档规范
百度千帆文档规范
入门
📎
华为云 - 技能文档模板
华为云文档模板
入门
📎
CSDN - 技术文档写作
技术文档写作
入门
📎
掘金 - README编写技巧
README编写技巧
入门
📎
SegmentFault - API文档设计
API文档设计
进阶
📎
中文技术文档规范
中文技术文档规范
入门
📎
开源中国 - 文档工具汇总
文档工具汇总
进阶
📎
Write the Docs
写文档社区
入门
📎
Divio Documentation System
Divio文档系统
入门
📎
Docusaurus
Docusaurus文档站
入门
📎
Read the Docs
Read the Docs
入门
📎
Swagger/OpenAPI Docs
Swagger UI
进阶
📎
Nextra
Nextra文档框架
入门
📎
GitBook
GitBook文档平台
入门