# MindSpore文档写作规范

| 文档类型 | 内容要求 | 格式要求 |
| --- | --- | --- |
| 开发指南（含教程、编程指南等文档）| - 每篇文档需要包括**开发概述**、**开发任务**和**样例代码**三部分。 <br> - 所有文档需有完整可运行的代码，文档只允许以下两种方式： <br> 1. Notebook（可一键运行） <br> 2. Markdown+可一键运行的完整代码/代码工程 | - [Notebook](./docs_notebook_guidelines.md) <br> - [Markdown](./docs_markdown_guidelines.md)|
| API描述 | [API Checklist](./docs_api_checklist.md) | - [中文](./docs_zh_api_guidelines.md) <br> - [英文](./docs_comments_guidelines_zh_cn.md) |
| 样例代码（含开发指南和API）| 典型、完整、可运行、易复现、没有WARNING/ERROR信息 | - [import方式推荐](./docs_import.md) |