精华内容
下载资源
问答
  • 如何编写技术文档

    2013-06-05 12:53:14
    写好技术文档必读。相较于国外的技术文档,国内的技术文档写作还有相当大的提升空间。
  • 使用有道云笔记编写技术文档还是很爽的比如: 代码块 //代码 public static void main(String[] args){ print("Hello world") } 流程梳理 graph LR A-->B 时序图,调用链 sequenceDiagram A->>B: How ...

    使用有道云笔记编写技术文档还是很爽的比如:

    代码块

    //代码
    public static void main(String[] args){
        print("Hello world")
    }
    
    

    流程梳理

    graph LR
    A-->B
    

    在这里插入图片描述

    时序图,调用链

    sequenceDiagram
    A->>B: How are you?
    B->>A: Great!
    

    在这里插入图片描述

    甘特图 排期挺好用

    gantt
    dateFormat YYYY-MM-DD
    section S1
    T1: 2014-01-01, 9d
    section S2
    T2: 2014-01-11, 9d
    section S3
    T3: 2014-01-02, 9d
    

    在这里插入图片描述

    展开全文
  • TechDoc是Jekyll主题,旨在编写技术文档。 它附带的模板非常少,因此您可以快速开始编写文档。 安装 将此行添加到您的Jekyll网站的Gemfile : gem "techdoc" 并将此行添加到您的Jekyll网站的_config.yml : theme...
  • https://www.cnblogs.com/noticeable/p/9010881.html
    展开全文
  • 小议程序员编写技术文档

    千次阅读 2008-08-07 10:02:00
    一提到写文档,可能很多程序员可能会不屑一顾,但是,无论处于规范开发流程... 昨天在和同事的一次交流过程中,就自己编写的讲演文档得到大家的一些有益反馈,不敢独享,晒出来和大家一起分享:首先,要明确文档的应用
        一提到写文档,可能很多程序员可能会不屑一顾,但是,无论处于规范开发流程,还是就于逃避嫌责的目的,能够将自己所从事的工作用文档描述记录下来,还是一件很有成就感的事情,抛开其功用不谈,就个人的成长进程看,也是一个循序渐进式的好习惯,还是值得大家稍微关注一下的。
    
        昨天在和同事的一次交流过程中,就自己编写的讲演文档得到大家的一些有益反馈,不敢独享,晒出来和大家一起分享:首先,要明确文档的应用人群和该人群对其内容的偏好程度,因为人越多,需求点可能就会越多,而我们往往会采取一条主观内容路线的方式进行串接、讲解,这样的逻辑顺延效果主要发生在我们自身,而对于听众来说,可能就很难达到进一步的共鸣了,但,这一点往往不被我们察觉,自我感觉思路清晰,侃侃而谈,就认为自己交流的够清晰,其实不然,听众对该内容不出意外都会较我们少很多,就我们记录的文档内容,可能很难将这些内容进行串接,进而形成一个清晰的概念,于是降低了交流效果,加上大家又比较晦涩,可能不会就过多的内容进行异议,于是……
        如何才能有所改进呢?
    (1)在编写文档前,就目标群体进行一下简短的需求调研
    (2)将文档的理解点尽量降低,由浅入深地进行介绍,并尽量将一些要点醒目标出,方便温习和查找
    (3)文档中尽量使用图释来记录信息,文字内容要少而精,但是切忌图释为取彩而忘本,华丽并不能代替标准的信息传达
    (4)根据文档进行讲解的时候,最好能够同时使用实时系统进行辅助,要擅于使用好投影仪等讲解工具
    (5)注意大家的意见反馈,就讲解过程中出现的一些不能马上回答的问题,要在交流后第一时间反馈给大家

    展开全文
  • 初识DocBook(编写技术文档的工具)

    千次阅读 2014-05-29 14:22:54
    突然在Linux下看到一堆命令: [root@localhost default]# do do docbook2rtf docbook2txt dosfsck doveconf doxytag ...基于此,Developer可以编写,修改和管理技术文档,并实现“一次编写,随便阅读”。

    突然在Linux下看到一堆命令:

    [root@localhost default]# do
    do            docbook2rtf   docbook2txt   dosfsck       doveconf      doxytag       
    docbook2html  docbook2tex   domainname    dosfslabel    dovecot       
    docbook2man   docbook2texi  done          doveadm       doxygen       
    [root@localhost default]# man docbook2txt

    马上百度了docbook的相关资料。

    DocBook是一种文档工具,特别适合技术人员用做文档编写。感觉早该知道有这玩意了,就像知道visio和project这样良好的工具一样,好的工具就像是武侠世界里的神器,只不过这个神器人人可得,却不是人人知道。


    下面内容是转载自 http://blog.sina.com.cn/s/blog_517d1cb00100uqcv.html

    责搭建一个叫做AutoDoc的环境用于帮助开发人员协作编写技术文档并生成各种不同类型的输出(比如:HTML, PDF, RTF等)。
    AutoDoc 的基础是 DocBook 以及 FOP, Ant, Ant-Contrib, Maven, Hudson, SVN 等技术和开源项目。

    AutoDoc的总体架构图:

    让Developer用DocBook编写技术文档
    关于Hudson,Maven和SVN的安装和配置,这里我就不详述了。请参考官方文档。

    我们需要在Eclipse里为AutoDoc创建一个Project,然后导入其他依赖的组件。下面是AutoDoc用到的资源:
    (推荐使用DownThemAll!下载)
    注意:apache-ant-1.7.*需要使用Java 1.6运行。其他版本,请查看Release Notes。

    下面对各个组件需要导入的文件做一个简单的介绍:
    • docbook-5.0: 只需要导入docbook.dtd文件。
    • docbook-xsl-ns-1.76.1: 导入所有文件。
    • fop-1.0: 导入build和lib文件夹中的所有jar文件。
    • ant-contrib: 导入根目录下的ant-contrib-1.0b3.jar和lib文件夹下的所有jar文件。
    导入的过程:
    1. 选择Project, 右键->“Import...”
    2. 在Import对话窗口,填入“Archive”到“Select an import source”文本框中,然后选择“Archive File”节点,点击“Next”
    3. 点击“Browser...”选择对应的zip文件,比如“D:\Download\docbook-5.0.zip”。点击“File Types...”,在“Select Types”对话窗口选择目标文件的扩展名,比如“*.dtd”,点击“OK”。
    4. 点击“Finish”
    源文件(基于DocBook DTD的XML文件以及其他相关文件)的组织结构图:
    让Developer用DocBook编写技术文档

    采用这个组织结构的原因是:
    1. 易于组织文档以及文档片断和插入文档中的图片等
    2. 易于维护和管理
    构建过程比较复杂:
    1. 如果temp文件夹存在,删除
    2. 拷贝src文件夹下的文件到temp文件夹(导出文件除外,比如*.pdf,*.html等)
    3. 将隶属文件(partition source files)中的XML指令和DOCTYPE指令删除(用空格替换)
    4. 将主文件中的DTD路径替换为公共路径(配置在build.properties文件中)
    5. 扫描temp文件夹及其子文件夹下所有符合命名规则 - “*main.xml”的XML文件(即主文件)
    6. 处理主文件,导出*.fo文件
    7. 基于*.fo文件,导出*.pdf文件和*.rtf文件
    8. 导出*.html文件(修改图片文件的绝对路径为相对路径 - 这样无论在本地还是Web服务器都可正常显示图片)
    构建完毕,剩下的工作就是学习DocBook DTD 和 DocBook XSL了。基于此,Developer可以编写,修改和管理技术文档,并实现“一次编写,随便阅读”。

    展开全文
  • 技术文档编写经验总结

    千次阅读 2019-04-18 23:25:36
    又一个项目即将结束,从编写技术文档、代码开发到联调,8个人还不到两周的时间,居然完成了,想想自己都很吃惊。 虽然是个小项目,但还是有很多东西需要沉淀下来。 正好晚上吃饱了没事干,写个博客记录一下技术...
  • 软件技术文档编写 重点 (Top highlight) 如何编写好的软件技术文档 (How to write good software technical documentation)This article aims to help developers to write better documentation. As a developer, ...
  • 中文技术文档编写规范,详细说明了文档如何编写,对从事技术的人大有裨益。
  • 缺乏准确性以及内容晦涩难懂都会让开发新手以及其他的一些技术工作者们对这些技术文档敬而远之,从而不利于他们的学习和...在本篇文章中,我们要讨论的就是如何在你的开发小组中编写出准确而且易于掌握的技术文档……
  • 网络工程技术文档编写规范
  • 在项目开发过程中,应该按要求编写好十三种文档文档编制要求具有针对性、精确性、清晰性、完整性、灵活性、可追溯性。◇可行性分析报告:说明该软件开发项目的实现在技术上、经济上和社会因素上的可行性,评述为了...
  • 技术文档编写心得

    2018-12-28 09:47:58
    技术文档编写首先寻找资料,阅读资料可以和编写文档同时进行,即编写段落一时查询段落一的相关资料,当编写到后面的段落时,发现和前面的段落有冲突,在回头整改,整个过程类似于ABSD和螺旋开发模式。 第一部分技术...
  • 技术文档编写typora

    2020-09-28 09:01:25
    最近使用了一下技术文档编写工具,感觉蛮不错的,简单方便。 英文不好的可以使用中文帮助。 https://www.typora.io/#windows
  • flexflexflex技术文档编写欣赏作者flex技术文档编写欣赏作者flex技术文档编写欣赏作者flex技术文档编写欣赏作者
  • 软件开发技能实训教程——技术文档篇(跟Microsoft工程师学技术文档编写
  • SSI技术文档

    2019-04-10 14:28:05
    SSI技术文档 详细介绍SSI协议 并且有详细时序介绍 可根据文档编写程序
  • Markdown技术文档编写规范

    千次阅读 2020-06-28 17:23:35
    Markdown技术文档编写规范 Markdown是一种可以使用普通文本编辑器编写的标记语言,通过简单的标记语法,它可以使普通文本内容具有一定的格式。 文档体系 结构 简介(Introduction): [必备] [文件] 提供对...
  • 技术文档自动生成器

    2008-05-09 20:40:04
    还在为编写技术文档烦恼吗?赶快看看吧,帮你解决大问题,很好用
  • bookdown:使用R Markdown编写书籍和技术文档
  • 学习编写java类的技术文档 刚刚学习了毕老师的自学课程的第六天内容,来练习一下写类的技术文档。 用的是《java数据结构与算法》一书中的一个银行账户类。 /** 银行账户类,可以建立一个账户,存钱,取钱,查询余额 ...
  • 在工作中或者在发布开源项目时,需要编写技术文档,以便别人使用时,或者自己过了很久之后去看不会一脸懵逼。 我觉得写技术文档应该是一个程序员必备的技能,好的技术文档包括以下几个特性: 结构简单:将自己的...
  • 对改善软件技术文档编写很有帮助,可以下来看看
  • 编写方案时技术路线参考文档

空空如也

空空如也

1 2 3 4 5 ... 20
收藏数 349,865
精华内容 139,946
关键字:

如何编写技术文档