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

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

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

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

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

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

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

第一步、注册账号登录

二、点击创建新文档

填类型

右上角编辑

新建章节

复制粘贴也有格式，不错

点右上角橙色图标同步

返回首页发布

成功

开发人员(程序员)怎么写技术文档相关推荐

java开发文档怎么写_程序员该不该写技术文档，怎么写文档，易懂又能提升自己...
最近公司项目的调用量突然涨了一大波,很多系统都纷纷扛不住了,于是需要对系统进行优化,系统优化的第一步,便是梳理业务! 在这个过程中,经常出现了这样一些情况,发现数据库的某些字段,没有注释,也没有一定的 ...
优秀程序猿写技术文档的正确姿势
一.背景写文档是程序猿进阶的一个必要步骤之一. 文档写的清楚,思路就更加清晰,也会让同事高看你一眼,多梳理业务也有很大帮助. 产品经理对需求文档基本是驾轻就熟信手拈来,但是大多数程序猿写技术文档却显 ...
不写技术文档是个什么梗
写文档在工作中很常见了,正规的公司都有文档,除非是很简单的东西. 文档用来给新人或不熟悉的人的看,出需求也要文档.只凭笔在本子上划几下不能让人懂. 凡是稍微复杂的东西一定用文档梳理流程,有的还有流程图 ...
如何写一份程序员爱看的需求文档？
上回分享的从需求到最终的解决方案,产品经理该怎么做?得到了许多人的认可,在这里,非常感谢大家的支持,同时也给笔者很大的信心,接下来分享的文章,希望大家能够喜欢,enjoy- 产品经理的生涯中,肯定遇到 ...
android技术文档怎么写,技术文档编写指南
技术文档编写指南首先请阅读文案风格指南 ##学习产品使用方式最重要的必备的条件就是: 一定要亲自使用这个产品,至少是一遍通顺的流程要走完,不要求每一个接口都一定使用过,但是一个完整的功能片段是使用 ...
写技术文档需要注意什么
技术文档总是令人头大, 一是文档内容可能不够全面,可读性差,可操作性差二是不知该从何写起,在此简单总结一下之前的内容和思路: 目录一.操作类.代码demo文档二.技术介绍类文档一.操作类.代码 ...
程序员面试用TXT文档写出纸牌接龙，HR当场月薪18K聘请，还能有这种骚操作？...
今天小编逛论坛,看到了一位大牛写的博文,去一家创业公司面试,用TXT文档写出纸牌接龙,虽然第一次运行有几个BUG,但整体水平不错,最终和HR一番交流,给出了18K月薪的水平,让小遍我惊叹了,别说100 ...
redis深度历险 pdf_程序员面试必备精选文档：Redis+Ng+Tomcat+并发编程+Spring系列
前言相信好多程序员都想在金三银四的时候找到或者跳槽到自己心仪的大厂.但是,今年的错过了,学习的脚步是不能停下的,这样才会抓住每一次机会,希望大家都可以找到自己心仪的公司就业.当然,除了做项目来提高自 ...
[转]想要成为一名优秀的Java程序员，这份文档必读
A.规则(1–2 级) 1.在switch 中每个 case 语句都应该包含 break 或者 return . 2.不要使用空的for .if .while 语句. 3.在运算中不要减小数据的精度. ...

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

开发人员(程序员)怎么写技术文档相关推荐

最新文章

热门文章