Skip to content
VitePress
Search
K
Main Navigation
首页
前端技术栈
HTML
CSS
JavaScript 基础
TypeScript
ECMAScript 6
AJAX 异步编程
Node.js
JSON
Vue 3
UI 框架
Markdown
Metter Admin
前端工具集
前端性能优化
前端代码规范
后端技术栈
Java
Spring Framework
Spring MVC
Spring Boot
Spring Cloud
MyBatis
工作流引擎
API 文档生成
SQL
MySQL
Redis
对象存储
消息队列
测试
Maven
Jenkins
Docker
工具类
开发工具
IDEA 2022.3.3
Visual Studio Code
文本编辑器
项目管理
开发环境
Tomcat
Nginx
版本管理
Windows 系统
Linux 系统
测试技术栈
自动化测试
接口测试
CI/CD持续集成
通用技术框架
测试工具
文档编写规范
其它
文档规范
免费电子书
Appearance
Menu
Return to top
目录
Simplify software development with the One DevOps Platform. Start your free 30 day trial today!
用户手册编写要求
编写内容
完整性
一致性
准确性
统一性
编写风格
描述规范准确,在描述内容、说明方法、提出见解时都应准确无误,恰如其分。用词应标准、统一、规范。
尽可能将信息制成表格,表格可改善信息的可读性。在需要根据不同的基础描述对象,或在不同的维度间比较对象时,可应用表格。
通俗易懂,尽量不使用较深奥的计算机术语,如果不可避免,应该给予适当的解释和说明。
层次分明,每节的内容必须明确,这样用户可以通过目录很方便地查到自己所需要的内容;注意段的划分,每段不要太长,突出重点,否则用户不容易获得其中的精华。
前后一致,在文档中使用的概念、术语的用词要前后保持一致。