爱生活

标题: 如何写好文档，怎么写文档 [打印本页]

作者: 123 时间: 2022-9-14 11:45
标题: 如何写好文档，怎么写文档

如何写好文档

1. 弄清读者是谁：给最终用户（小白）的、给系统维护人员、给后来的技术人员交接的的文档肯定不一样，给小白的重截屏，给维护的重操作，交接的重原理。2. 切换“无知者”模式：很多东西是在做项目的过程中试错积累出来的。做着做着：这么干原来不行啊，应该这样这样，改设计！做着做着：哎呀，原来有这个问题没有考虑到，现在加进去，改设计！做着做着：哦？什么？客户要改需求？好吧，我改设计！这样下来大型的IT项目做到最后，和最开始的设计已经大相径庭了，按照原来设计的思路来写文档肯定是不行的，按照时间顺序把修改加上会更加混乱。写文档的时候需要切换到“无知者”模式，把自己想象成一个刚刚接受项目要开始设计的人，面对已知的这些“新要求”和对技术全新的理解，重新写一份文档，这样才能脉络清晰，可读性高。3. 遵循标准构架：大型项目牵扯的东西多，有实际的设备有虚的概念，有用户界面也有关键性配置，杂七杂八什么都有，如果不按照一个标准构架来写文档，很容易就眉毛胡子一把抓。这时候就一定要找一个标准构架，比如OSI七层构架，TCP-IP四层构架等等，从上到下或者从下到上，写着也方便，看着也舒服。
--------
1、尝试编写个人简历和经历，用文字来认识

欢迎光临爱生活 (https://ish.ac.cn/)