武汉IT培训学校技术讲师谈学软件开发如何写技术文档

     我一直认为写技术文档就像盖房子，当然不是盖一层楼的房子，是盖高楼大厦，当然是一个复杂的工程。

     写文档肯定是先确定一个主题，就像是盖房子前给要盖的房子确定一个建筑共用一样。这是关键的一点。然后开始收集写这边文档的资料，好比盖房子前采购必要的建筑材料一样。文档主题主题，开始思考分几部来阐述，就像确定一个大厦应该分几层。

    这个时候我建议就写出文档的完整详细的提纲，然后整理出文章的目录。这里肯定有很多人觉得，这个时候文章还没有开始写，就要确定出明确的目录，是不是太难了。是的，肯定是有点难度的。但是如果写的文章字数不超过2000字，还可以，但超过两千字了，如果没有明确的目录，当文件长了后，文章肯定会变形，肯定无法做到围绕主题中心展开。而如果有明确的目录，你就可以控制好文章，不至于跑题，不至于偏离中心主题。就像是高楼大厦，必须是搭建完毕框架的，这样能保证大厦始终垂直向上，大厦的重心始终位于地基的重点，而不至于由于大厦太高而倒掉。

    确定好目录其实也就是确定了文章的章节组成。这个时候我们就要确定每个章节中的观点我们是通过哪种方式去表达，是通过文字、图例和图表，还是通过代码去阐述我们的观点，让读者容易接受。这个时候没有统一的标准，要看具体的主题。写大篇技术文章时，一定要采用多种手段来说明自己的观点，而不能单纯采用文字，这样会使文章看起来过于单调。更好根据不同的分论点，采用多样的表述手段，是自己的文章看起来图文并茂。 其实写文档也是一个技术活，同样遵循着“熟能生巧”的规律。

    刚开始写文档，肯定是不知道如何去组织语言，不知道怎么下笔，觉得效率低。但不能因为这个而停止前进的脚步，需要耐下性子，客服畏难的心理，继续写下去。文章写多了，自然会“下笔如有神”，越写越顺畅。

    来到北大青鸟武汉宏鹏光谷校区的学子们都希望自己能够有一番作为，在学习软件开发的路途上，武汉宏鹏的技术老师们甘愿做一颗铺路石，以自身的经验作为养料，帮助学员们获得更多更前沿的IT技术。