美文网首页
思考_实践_如何写技术类文档(记录)

思考_实践_如何写技术类文档(记录)

作者: FlyingPig_ | 来源:发表于2018-11-08 18:02 被阅读8次

一点小小的思考

核心

专业性, 严谨性, 创新性, 趣味性

方法

多看,多搜,多想,多写

内容:

总结过程,像写日记一样.

关于太简单的记录,即使时很容易就可以查询到的解决方案(现实中遇到的80%的问题都是如此),对于自己来说,可能还是会存在认识上的问题,记录下来一可以加深印象,二可以练习语言表达,三可能会给新人以帮助.

当然,有必要提升文章中的技术深度,但这一过程没那么容易,更好更合适的方案应该是边写边学,边学边写,慢慢进步.

关于时间占用,老实说,工作时发呆看手机的时间已经很久了,若把这段时间利用起来,做点有趣有意义的事,岂不更好.

关于无人来看,不care,只是作为自己的记录,若可以坚持写下去,回头再看也是收获满满.

现在的基本要求

像写ppt报告一样写文档
程序代码无错误
表达无错别字
表达简练,不说废话
尽可能的拓宽广度,深度目前不必要求过高
多搜集,制作,总结图和表
认识一件新的东西,循序渐进,一步一个案例

相关文章

网友评论

      本文标题:思考_实践_如何写技术类文档(记录)

      本文链接:https://www.haomeiwen.com/subject/bfawxqtx.html