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

本文档旨在指导开发人员如何撰写技术文档,尤其是在缺乏可用资源的情况下。作者分享了在寻找SpringBoot文档未果后,决定翻译官方指南的经验,并推荐了一个免费的文档托管平台kancloud.cn,作为类似ReadTheDocs的替代方案。文章还讨论了避免使用本地Markdown工具(如gitbook)以防丢失,并详细介绍了在kancloud.cn上创建和发布文档的步骤。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

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

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

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

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

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

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

第一步、注册

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值