工程师文档编写注意事项
1.重要文档避免简称的出现,一定要使用全称;
2.文档输出对象决定编写方式,如果文档是写给运维同事,那么步骤一定要一步一步清晰有序有条理,换位思考让人看明白;
3.写完文档要更新整个目录的域;
4.写完文档要检查页眉、页脚的文字是否与交付项目对应;
5.文件名称或标题中,涉及英文字母的注意当大写时一定大写。