你用什么写文档?

confluence:公司行政制度文档,开发流程文档

方法api文档

组件参数文档

组件ui文档

原文地址:https://www.cnblogs.com/camille666/p/write_doc_by_tools.html

时间: 2024-10-12 20:42:37

你用什么写文档?的相关文章

写文档的一些感触

软工写文档也有一个多星期了,还没有写完,感觉太慢了~ 对于软工文档,最大的感觉就是不知道该怎么写.问过一个师哥,师哥说这次写主要是为了让我们先了解一下写文档,现在让我们真正写那肯定是写不好的.后面还会有项目来练习的. 真正优秀的程序员应该不单是编程高手,同时也应该是写文档的高手.大多数程序员是不喜欢写文档的.文档种类多,要求多.需求的改变和代码的改变都会让文档如同一张过时的废纸一样.很多程序员不写文档照样能编出程序来,文档的好处更多的体现在公司.用户和后续程序员身上.这样即使程序员走了,只要有文

从程序员到项目经理(29):怎样写文档【转载】

在软件项目中,文档既是一项的重要成果,也是项目管 理的有力工具.通过文档,可以稳定.明确的传达信息,实现项目内的有效沟通.所以写文档对项目经理来说,是一项必备的技能. 然而很多项目经理害怕写文档,似乎这是一个很麻烦. 很困难的工作.其实会不会写文档,只是一种外在的表现,通过一个人写文档的情况,可以看出他对工作的理解程度,发现潜在的问题和风险.一个合格的项目经理,不但不会怕写文档, 而且会觉得这是一件简单.很自然的情,就像一个人吃饭.喝水一样,何难之有? (本人拙作<程序员第二步 -从程序员到项目

从 Word 到 Docbook, 最后用 Pandoc, 让程序员爱上写文档

写文档一直是程序员非常讨厌的工作, 甚至和改需求一样令人厌烦. 在程序员眼里比写程序还难, 即便强制执行下来文档质量也很难让人满意. 相信大多数公司写文档都是用 Word, 笔者也是用了 Word 写了好几个项目的文档. 架构, 设计, 运维等好几份, 呵呵, 即便是写的再好, 交给客户也基本是不看的. 一个文档是项目组内好几个成员编写的, 大家各写各的模块, 各自的实现, 然后一起合并, 合并时修改字体, 字号, 目录等, 第一次合并还好, 再升级几个版本后, 大家改了哪里, 没改哪里, 根本

写文档能力培养

从本人的经历来看,大部分做项目的都写不好文档,但在实际工作中却又需要写大量的文档 比如写招标文书.投标文件.项目验收报告等等,除了写文档以外,还需要做PPT,给专家或客户进行详细讲解 说句不好听的话,项目的成败往往并不取决与你的软件技术有多高,有时候可能就是因为你的投标文件写的好.PPT做的漂亮就拿到了项目 1.要有封面.目录,不应该一上来就是正文,这样显得不正式 2.各章节的编号要统一,对项目报告来说一般来说使用多级标题,类似1.1.1.1.1.1这种标题,有层次感,其中标题字体根据标题的层级

Java中按行写文档的方法

原文引用https://www.dazhuanlan.com/2019/08/25/5d622ab9a21fa/ 这篇文章总结了使用相关类写文档的操作 1. FileOutputStream 12345678910 public static void writeFile1() throws IOException { File fout = new File("out.txt"); FileOutputStream fos = new FileOutputStream(fout);

使用Markdown写文档

转载于:http://blog.csdn.net/xiahouzuoxin/article/details/19752603 Markdown是一种网络书写语言,其目标是实现易读易写,且兼容HTML语言.Markdown的流行得益于Github和Stackoverflow,Stackoverflow的代码块以及Github上的README.md文件格式都是通过Markdown表现的.从这里您可以很直观的看到Markdown的效果:https://github.com/adam-p/markdow

Java POI Word 写文档

package apache.poi; import java.io.ByteArrayInputStream;import java.io.ByteArrayOutputStream;import java.io.File;import java.io.FileInputStream;import java.io.FileOutputStream;import java.io.IOException;import java.io.OutputStream;import java.util.Ha

锋神教我数据库,吴大哥教我写文档——其一

昨晚锋神说:实体集就是脱离了其他集可以独自存在的,联系集就是与其他集产生联系才有存在意义的 (一下摘自mactalk迟建强微信公众平台) 传统的软件产品开发一般是这样的: 1.确定产品定位和需求,确定首次迭代的范围.2.制作界面原型.3.技术选型,然后根据技术选型为每个开发者搭建开发环境和技术栈,例如 Java 环境.Python 环境.Ruby 环境.数据库.中间件等等.4.构建基础技术框架和服务,包括日志.存储.消息.缓存.搜索.数据源.集群扩展等等.5.模拟用户容量,构建测试环境.6.开始

文档要怎么写?

题记:今天立秋了,明天永远是美好的一天 场景 最近给运维人员写了一份部署三个项目的文档,由于系统需要和其他两个系统交互,所以在配置方面复杂了些,尤其是对xml文件地址配置这块,经常出问题.当基本功能实现的时候,给运维人员去部署的时候,写文档不单单是给别人写,更多的是给自己写.写的过程中思路清晰了,一切都会变得明朗起来,有一种山穷水复疑无路,柳暗花明又一村的感觉,并且一下子把需要大脑中记忆的这些事情全部转移到了文字上,一个字,舒服~,就像清理了电脑中的垃圾空间一样. 不过当我把写好的文档实际上去交