开发人员(程序员)怎么写技术文档

声明:本篇文章不带任何软文及打广告性质,该用的工具还得用!!!

今天,在找springboot资料没发现好的中文文档,即使有springboot某些框架的使用博客,也都是碎片化的,对小白极度不友好,连概念都没有怎么会去找,便打算翻译spring官方的一些指南(英文的,很难受),不管能不能坚持,先写写,接着发现连教怎么写文档的都没有,what the fuck!!!天下文章一大抄,垃圾信息一大堆

后来发现这个网站https://www.kancloud.cn/dashboard

之前看过一些在这网站托管的文档,嗯,不错,免费就行

这玩意有点像https://readthedocs.org/,不错,果然同一种项目国内外都有竞品,还是有点需求的

那些像gitbook  这种本地markdown文档本地生成工具就算了,万一丢了呢??

第一步、注册

  • 0
    点赞
  • 3
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
技术文档程序员工作中非常重要的一部分,下面是一些建议来帮助你技术文档: 1.明确目标受众:确定你的文档是面向其他开发人员、经理、客户还是非技术人员。这有助于你选择合适的语言和术语,并确保你的文档能够满足读者的需求。 2.使用清晰简洁的语言:避免使用过于复杂的术语和缩,尽量使用通俗易懂的语言来解释技术概念。如果必须使用特定术语,确保在文档中提供清晰的解释和定义。 3.结构化和组织良好:将文档分成几个部分,例如介绍、使用指南、API文档等。使用标题、段落和列表来组织内容,以便读者可以轻松地找到所需信息。 4.提供示例代码和截图:在文档中提供具体的示例代码和截图,这有助于读者理解技术概念和步骤。确保示例代码准确、可运行,并附带适当的注释。 5.使用图表和图像:使用图表和图像来说明复杂的流程、架构或数据关系。这些图像可以帮助读者更好地理解和记忆文档中的信息。 6.更新和维护:技术文档应该与软件的版本保持同步,并定期进行更新和维护。确保删除或更新过时的信息,并添加新的功能和变更。 7.注重用户反馈:接受用户的反馈和建议,并根据需要对文档进行改进。这有助于提高文档的质量和可理解性。 最后,记住技术文档是一项技能,需要不断的实践和改进。随着经验的积累,你会变得更加熟练并能够编出高质量的技术文档

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值