我最喜爱的十大技术文档写作工具

2023-10-27

转载

老实说,我爱死微软的Word了!Adobe FrameMaker也曾辉煌过,不过你懂的,这东西有时候会令人抓狂。过去5年来,我一直使用同一套写作工具。我也曾尝试过一些新的工具,可我最终还是很专情于我的老相好们。在这里我总结了一下我所用过的工具(排名不分先后)。诸位看官,您觉得哪些工具我该继续使用,哪些又该被替换掉呢?

技术文档写作工具合集

Microsoft Word

我有90%的技术文档写作是用Word完成的。不管您喜不喜欢它,此工具的确是这个星球上最普遍的写作工具。Adobe FrameMaker可能名气不错,但绝大多数的工程师、测试人员还有其他贡献者都是用MS word来写自己的文档。没有它,我的饭碗就不保啦。想问下,您不靠这个工具能糊口么?

Adobe FrameMaker

这家伙用来处理所谓的“大部头”比较完美。在它崩溃之前(不好意思,那是我的笔记本惹的祸……),数年间我一直在用它。
Adobe FrameMaker谈不上什么稳定性,不过其用户界面挺好玩的。
Adobe FrameMaker比较适用于带有曲线、表格、图表的复杂“图书”。跟Word不一样的是,它可以记住设置,而且模板用起来也很顺手。

但, FrameMaker的问题就在于……

它太难自定义了(对我而言)。比方说我想要导出/导入文档,甚至弄成PDF格式也会很麻烦。不明真相的你一定会很天真地认为Adobe早已解决这类问题了……

Camtasia

用Camtasia来制作电影、教程还有录制屏幕。Techsmith公司的产品向来很好用,这个也不例外。我可以用它来制作视频(例如关于某应用程序的视屏),然后后期加入配音,注解以及导出为HTML格式或者Flash。这可以说得上是我最喜欢的一款工具吧!真希望我有更多的理由来使用它。

Snagit
网上有很多比Snagit便宜的截图工具,甚至还有免费的,但我坚持只用Snagit。考虑到它给你带来的便利,价格问题其实不值得一谈。对了,Techsmith公司的员工也挺乐于助人的。
Snagit到底有何过人之处呢?
我喜欢它的原因很简单:
只需点一下(您可以把截图按钮嵌入到浏览器去)就可以截图,接下来自动载入到编辑器中以便进一步的裁剪、编辑和修改 。其他特色包括 批量处理图片 ,例如批量为图片添加您的个人网址水印或为图片镶一个漂亮的边框。
Adobe Photoshop

我一毕业就进入桌上出版业,因此PS一直是我的弱点。事实上,编辑图片与写文章是很好的劳逸结合。我也发觉,有精美插图的文档通常会比那些纯文字文档更引人注意。

Visio

这是我用来制作流程图示意图的唯一工具。Smartdraw定价更有优势,但这事儿我看得很透彻:我可以用Visio快速地把大幅图表导入MS Word中而不必担心在编辑流程中会损坏文档。

学会如何(正确地)创建流程图让我明白Visio确实好用。它算不上是最直观的程序,但当你投入其中时,你会发现它真的很棒!

Epic Editor

我最近开始接触DITA以及结构化写作,用的正是这个小工具。这东西很不容易上手(跟Word相反),但当您开始摸到窍门时,您就可以体会到它的强大了。Epic Editor价格不菲,不过要是您需要一款重量级技术文档写作工具的话,这个投资还是挺值得的。
此工具适用于“块状”型的内容创作,DITA地图以及任务型的信息。

Notepad++

系统自带的记事本其实还行,我还用过UltraEdit。事实上,UltraEdit是我用过的最好的编辑器,可惜它在发展过程中变成了商业软件(还是说我以前一直没注意到它的广告?),因此被我抛弃了。我喜欢的一个功能是它可以记住上次打开过的文档并在启动时自动将之打开,这样我就可以快速地投入工作。“行计数器”也是它的一个很贴心的功能。

RoboHelp

至于说创建帮助文件和在线文档……呃,其实我想说的就是Doc-to-Help这个工具啦!N年前在伦敦,我就是靠它入行的。
杯具的是,Doc-to-Help在市场上貌似已经风光不再,而另一款工具RoboHelp则是步步高歌。Adobe公司买下了RoboHelp,投入了不少资源开发它,(某种意义上)跟Adobe FramMaker绑定在一起。现在,RoboHelp是事实上的帮助文档写作工具代名词。或者说它还不能成为代名词,Flare才算?

XML Spy

在某种程度上,我们都纠结于XML。这款工具UI很友好,能够显示出树状结构的标签以及它们是如何关联的。对于一个跟我一样没有一丁点XML知识的人来说,XML Spy的显示方式让我能够处理好代码,捣鼓出文档,最后全身而退且不会搞坏程序。

荣誉榜
  • Adobe Acrobat
  • Doc-to-Help
  • InDesign (PageMaker替代品)
  • MadCap Flare
  • SmartDraw
  • Turbodemo (录制屏幕视频以及教程)
  • WhiteSmoke (点击查看更多商务英语写作信息)
那么,您使用的又是哪些技术文档写作工具呢?

您认为上面提到的工具中有哪些是我应该丢弃的?还有比Adobe FrameMaker更好的工具用来处理“大部头”么?又或者,我该停用Visio,转向某些开源工具?

本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)

我最喜爱的十大技术文档写作工具 的相关文章

  • MFC菜单的使用

    1 创建弹出菜单 1 利用向导 创建一个基于单文档的应用程序 2 在资源视图中选中 menu 鼠标右键插入一新菜单IDR POPMENU 3 在IDR POPMENU菜单中添加 弹出菜单 选项 在 弹出菜单 下添加菜单命令 复制 粘贴 查找
  • 想做硬件开发的人员必看

    转眼间 已经毕业一年了 在这一年中经历了很多 工作已经换了两个了 住的地方好像已经换了两三个了 这中间不包括跨地区生活 我刚大四的时候 应聘一家网络公司做硬件开发 03年的时刚过完年 我就千里迢迢的来到了一个陌生的地方 在这以前 我从来没有
  • openEuler的镜像地址以及换源openEulerOS.repo

    openEuler的镜像地址 https repo huaweicloud com openeuler 换源 执行如下命令 下载新的openEulerOS repo到 etc yum repos d 目录下 for aarch64 wget
  • 数学建模竞赛论文中的Word使用

    1 使用样式 除了Word原先所提供的标题 正文等样式外 还可以自定义样式 如果你发现自己是用选中文字然后用格式栏来设定格式的 一定要注意 想想其他地方是否需要相同的格式 如果是的话 最好就定义一个样式 对于相同排版表现的内容一定要坚持使用
  • Github使用学习笔记(四)

    第四节任务 Github中奇怪的后缀文件都是什么 一 README md 1 README md的作用 在构建完整项目结构的根目录下应该有一个名为ReadMe的文件来说明当前版本源码结构或版本信息 如果你常看开源项目也会发现一个规律 在你拿
  • 场景间切换与数据传递(以及物体删除技巧)

    先介绍一些基本函数 具体用法自己查文档 1 场景切换 Application LoadLevel Level1 2 读取场景时不移除物体 DontDestroyOnLoad object 会保留该物体的任何数据 包括坐标 可以用于任何物体
  • 右键里没有新建txt文件选项 win7

    试试这个方法吧 win7的试过 成功 找个文本文档 复制一个 把里面的内容清空 改后缀为reg 点右键 编辑 把下面的内容复制进去 保存 然后双击导入注册表 Windows Registry Editor Version 5 00 HKEY
  • 程序员模式

    在我的心中 程序员是一个做事有计划 有思想 具有高超技术 解决能力的艺术家 自己作为一个程序员 自愧不能达到如上的标准 看到过一个程序员曾经这样自嘲 一个只有半瓶子水晃晃荡荡的程序员 这些年来一直从事开发的工作 稀里糊涂跑过许多城市 流浪过
  • WSDL实例解析

    WSDL的主要文档元素 WSDL文档可以分为两部分 顶部分由抽象定义组成 而底部分则由具体描述组成 抽象部分以独立于平台和语言的方式定义SOAP消息 它们并不包含任何随 机器或语言而变的元素 这就定义了一系列服务 截然不同的应用都可以实现
  • 区块链相关术语(中英对照)

    原文链接 https wiki learnblockchain cn bitcoin en zh html 说明 阅读英文文档是编程开发过程中最常做的一件事 英文阅读也是一个程序员的基本能力 区块链刚刚起步 每天各种新概念层出不穷 为方便大
  • js基础学习第一天(关于DOM和BOM)一

    关于BOM和DOM BOM 下面一幅图很好的说明了BOM和DOM的关系 BOM提供了一些访问窗口对象的一些方法 我们可以用它来移动窗口位置 改变窗口大小 打开新窗口和关闭窗口 弹出对话框 进行导航以及获取客户的一些信息如 浏览器品牌版本 屏
  • 关于静态测试

    1 静态测试 静态测试是指不运行被测试程序而寻找程序代码中可能存在的错误或评估程序代码的过程 静态测试的特点是不需要运行代码 也不需要对代码编译 链接和生成可执行文件 它是通过分析或检查源程序的方法 结构 过程 接口等来检查程序的正确性 目
  • 支付宝API接口开发相关文档以及实例

    支付宝实物即时到账接口 在下载该接口之前 请确定你已经签约了即时到账的服务协议 并且账号已经开通了即时到账的权限 口常见错误问题搜集 http union alipay com alipay zhichi shiwu 商家工具FAQ pdf
  • 静态测试

    之前对 静态测试 一直不怎么理解 一直徘徊在为什么要进行静态测试 看了下面这几篇文章 突然觉得的柳暗花明了 目前我正在测试的项目xx让我烦心的问题终于找到出路了 http qa taobao com p 8017 http qa taoba
  • 计划 060703

    ESOE项目暂时作为一个自娱型项目 每日投入30分钟 近期按计划完成以下工作 1 完成计划 ok 2 完成对ESOE项目的介绍 ok 060704 3 在blog发布已有的 ESOE Specification v0 1 doc 英文版 o
  • AppDomain 和动态加载

    应用程序体系结构 在我专攻代码之前 我想谈谈我尝试做的事 您可能记得 SuperGraph 让您从函数列表中进行选择 我希望能够在具体的目录中放置外接程序程序集 让 SuperGraph 检测它们 加载它们 并找到它们中包含的所有函数 如果
  • 静态白盒测试-code review

    一 静态白盒测试概述 首先区分软件测试的几个术语 白盒测试 黑盒测试 静态测试 动态测试 白盒测试 也称为透明测试 clear box testing 白盒测试针对逻辑结构进行检查 它允许我们看到程序的内部结构 黑盒测试 black box
  • 英语学习对程序员得重要性!

    程序世界的主导语言是英文 编写程序时使用的开发文档和开发工具的帮助文件离不开英文 了解业界的最新动向 阅读技术文章离不开英文 同世界各地编程高手往往也离不开英文 提高英文水平 能大大促进一个程序员的发展 让你有更多的资源 在此 个人总结了几
  • 关于UI适配的文档

    第一部分 原理 1 根据当前屏幕尺寸与开发预设屏幕尺寸尺寸得出以下参数 1 XRatio 当前屏幕尺寸与开发尺寸的X轴比例 2 YRtaio 当前屏幕尺寸与开发尺寸的Y轴比例 3minRatio XRatio与YRtaio中的较小值 2 之
  • React 教程及其API接口文档

    React 详细中文开发文档 可以阅读 http reactjs cn react docs tutorial html 英文原文 http facebook github io react 中文论坛 http react china or

随机推荐

  • VTK入门001——HelloVTK

    include VTKPlatform h vtkConeSource 是 VTK 库中的一个类 用于生成一个圆锥体的几何形状 include
  • 网站数据分析报告怎么写?

    网站数据分析报告怎么写 1 目标 Objective 是前提 网站分析报告的起点不是从现象开始的 而是从网站的目标 objective 开始的 我相信大多数网站的目标不应该超过1个 那些各种目标都应该归结为一个最终的最根本的目标 如果你的老
  • CTF show 萌新web-1

    首先看题目 代码整体逻辑是先通过GET请求传递参数id 如果id大于999 报错 如果小于999 则输出当前的执行的sql语句 如果根据id参数能在数据库中查到值 row 则将其打印出来 而flag则是id为1000的 row中的内容 这道
  • excel表格(.csv)保存到数据库--QT数据库

    刚学QT的菜鸟 无聊的时候总会找一点事情做 言归正传 将excel表格保存到数据库 是比较简单的 我的想法简单粗暴 从路径中获取文件 通过按键控制加载 将大象放进冰箱需要是三步 这个同样 1 获取路径 2 读取Excel文件 3 将其保存到
  • Domain-Specific Languages 23

    Domain Specific Languages Whenever you listen to a discussion by experts in any domain be it chess players kindergarten
  • 红日靶场(五)

    红日5 一 环境搭建 此次靶场虚拟机共用两个 一个外网一个内网 用来练习红队相关内容和方向 主要包括常规信息收集 Web攻防 代码审计 漏洞利用 内网渗透以及域渗透等相关内容学习 1 环境拓扑图 2 靶机下载地址 漏洞详情 3 我们设置VM
  • elasticsearch 集群配置

    主节点配置 集群名称 cluster name demo 节点名称 每个节点的名称不能重复 node name es node 1 ip 地址 每个节点的地址不能重复 network host 172 16 10 1 是不是有资格主节点 n
  • Python-schema的使用

    不管我们做什么应用 只要和用户输入打交道 就有一个原则 永远不要相信用户的输入数据 意味着我们要对用户输入进行严格的验证 web开发时一般输入数据都以JSON形式发送到后端API API要对输入数据做验证 一般我都是加很多判断 各种if 导
  • Python生成随机数,并将生成的随机数组成10道加减乘除的基本算术题目

    编写一个小学生算术能力测试题 提供10道加减乘除四种基本算术运算的题目 联系者根据显示的题目输入自己的答案 程序自动判断输入的答案是否正确并显示出相应的信息 生成一到一百的随机数 import random x random randint
  • SRM系统是什么?

    SRM全称Supplier Relationship Management 即供应商关系管理 SRM管理系统即供应商关系管理系统 供应商管理系统是采购管理系统的一个子系统 也是采购管理系统的一个重要模块 是用于改进企业与供应商关系的联系 完
  • Mysql主键约束和唯一约束

    Mysql约束 1 作用 约束定义为确保数据完整性必须遵循的规则 约束可以在创建表的过程中创建 也可以稍后再添加 在创建表后添加约束时 它将检查现有数据以确定其是否违背该约束 如果现有数据违背了将添加的约束 那么将不会向指定列施加该约束 2
  • 找不到文件、主类名和文件名不一致、缺少分号的解决方法

    1 找不到文件 解决方法 源文件名不存在或写错 或者当前路径错误 2 主类名和文件名不一致 解决方法 声明为public的主类应与文件名一致 否则编译失败 3 缺少分号 解决方法 编译失败 注意错误出现的行数 再到源代码中指定位置改错
  • shell实例流程控制&函数

    条件 if then elif then fi if的条件部分经常使用test EXPRESSION或 EXPRESSION 实现 test的用法可以参见test if 条件1 if 条件1 then then 执行语句1 elif 条件2
  • MetaMask安装使用指南

    前言 MetaMask是一个以太坊钱包插件 虽然只能在Chrome浏览器中使用 但作为以太坊钱包的metamask却很受以太坊开发者欢迎 MetaMask除了是一个简单的钱包 它主要卖点是让使用者可以很容易跟以太坊的智能合约互动 或者说说M
  • DLUT C++上机作业(实验六)

    注意 博客所有代码在VS上均能编译通过 codeblocks等编译器可能因为某些变量名无法识别而无法编译 我的VS上不能用end做变量名就很迷呀 2 有一个交通工具类vehicle 将它作为基类派生小车类car 卡车类truck和轮船类bo
  • Java面试必备,JVM核心知识点总结!

    JVM基础 程序计数器 Program Counter Register CPU中的寄存器 作用 记住下一条JVM指令 特点 线程私有 唯一一个不会出现内存溢出的区域 虚拟机栈 Java virtual mechine Stack 线程私有
  • 数据库查询: 列出表的所有字段,“*”符号,查询指定字段数据,DISTINCT查询,IN查询,BETWEEN AND查询,LIKE模糊查询,对查询结果排序,分组查询,统计分组查询

    数据库查询 列出表的所有字段 符号 查询指定字段数据 DISTINCT查询 IN查询 BETWEEN AND查询 LIKE模糊查询 对查询结果排序 分组查询 统计分组查询 列出表的所有字段 通过SQL语句SELECT列出表的所有字段 具体语
  • 软考-嵌入式系统设计师-笔记:嵌入式系统软件基础知识

    文章目录 嵌入式软件基础知识 嵌入式操作系统基础知识 任务调度 信号量 页面置换算法 嵌入式系统程序设计 嵌入式软件基础知识 嵌入式软件分类 系统软件 控制和管理嵌入式系统资源 为嵌入式应用提供支持的各种软件 如设备驱动程序 嵌入式操作系统
  • build中配置resource配置,来防止资源导出失败

  • 我最喜爱的十大技术文档写作工具

    转载 老实说 我爱死微软的Word了 Adobe FrameMaker也曾辉煌过 不过你懂的 这东西有时候会令人抓狂 过去5年来 我一直使用同一套写作工具 我也曾尝试过一些新的工具 可我最终还是很专情于我的老相好们 在这里我总结了一下我所用