- 博客(154)
- 资源 (1)
- 收藏
- 关注
原创 还有飞书文档覆盖不了的场景?聊聊DITA文档标准适合哪些类型的企业
不管是生产实实在在东西的公司,比如汽车、冰箱、电脑芯片这些,还是做软件这种看不见摸不着的公司,都能用得上DITA。这些东西都有自己的型号,需要详细记录,而这类公司就可以用DITA来更好地管理它们的产品文档。而在DITA中除了这些通用的东西以外,还可以有通知、件号、单价、类型这些特定含义的信息。不仅可以生成方便用手机、电脑看的文档,还生成定制的PDF文件,Word文件,想打印出来或者在线分享都很方便。总之,不管你是做硬件产品还是软件产品,只要你需要写复杂的技术文档,DITA都能帮你更好地组织和发布文档。
2024-09-23 08:58:41 181
原创 企业中文档团队的三种组织形式
就是说,公司里头有几个不同的部门,每个部门都需要做文档。于是呢,公司就专门成立了个文档组,这组人就像个万能钥匙,哪儿需要就往哪儿钻,帮各部门搞定文档的事儿。平时,研发那边会给他们提供一些资料,他们再把这些资料整理成文档,最后还得让研发的人过目一下,确保内容没错才能正式发布。这个模式下,每个部门都有自己的文档专员,这些专员就跟研发的小伙伴们并肩作战,专攻自家部门的文档任务。还是那些部门,还是那些文档需求,不过这次公司设立的是一个文档支持小组。这就是我了解到的三种文档团队组织形式,你们公司用的是哪种模式呢?
2024-09-20 11:46:49 137
原创 流程文档:构建高效业务流程的详细指南
流程文档是创建完成特定业务项目所涉及的文档化流程的行为。本文档概述了流程从开始到结束的工作方式,确保所有团队成员都清楚地了解工作流。
2024-08-21 10:47:18 886
原创 产品文档全攻略:分类、价值及创建技巧
系统文档的技术部分针对的是技术含量很高的受众,如研究人员和工程师。:产品需求文档等文档是在对市场进行了大量研究并得到所有产品团队的输入后开发的。无论他们是使用你的产品的新手还是行业专家,都要调整相关的语气,使你的作品对产品面向的任何受众都是可读的。对于开发产品的后续版本的工程师来说,架构也是一个宝贵的资源。文档增强了产品的价值,并列出了产品的使用方式。一份详细的指南,其中包括使用产品的完整方法,也很好地发挥了其在营销中的作用。文档是对产品的补充。使用特定产品的详细指南可以建立用户使用您的品牌和产品的信心。
2024-08-16 11:02:29 626
原创 DITA发布MS Word样式定制
结构化文档能输出可编辑的Word格式,不过Oxygen/DITA-OT默认的DITA发布Word输出太过于基础,经过样式定制以后看看输出的word长啥样。
2024-08-08 10:01:37 1041
原创 DITA的优点和缺点
原文链接:https://stefan-jung.org/dita-introduction/DITA的实施可能是一项复杂的任务,本节列出了在实施DITA之前需要了解它的优缺点。如果不购买像Oxygen XML Editor这样的编辑器,难以真正用起来。强大的功能(内容重用、变量、关系表、键作用域、过滤器)可扩展,可以从文件系统开始,稍后迁移到企业CMS。用于DITA内容的发布工具DITA-OT是开源的。可以与版本控制系统一起使用,比如:Git。是基于XML的,需要了解XML。难以定制文档类型(专业化)
2024-08-01 09:44:12 320
原创 什么样的公司适合用DITA方法写产品文档
这些公司创造现实世界的实物产品,如汽车、冰箱或计算机芯片。每个产品的每个版本都有一个唯一的产品ID,需要记录下来。不同的产品有时在功能上相似,但也有一些差异。这些公司提供版本化的软件组件,通常安装在客户端。由于每个客户可能都有旧版本的产品,因此需要提供旧版本的用户手册。这些公司通常提供基于云的服务(SaaS),最终用户始终可以访问最新的稳定版本,并且没有为过去的版本提供用户手册。作者 | Radu Coravu。
2024-07-31 09:14:19 438
原创 结构化写作的好处:省去排版工作并让文档风格一致
结构化写作是编写技术文档的一种标准化方法,其中内容由预定义的规则控制。结构化写作的思想和Word不同,结构化写作中内容和样式(或者叫做视觉效果)是分开的。写作时不用关心输出是怎样的,也不用进行排版,只专心于内容创作本身。样式文件是针对各种情形提供统一的格式化方案,而不是针对每一个文件的每一处进行特殊处理,这就能保证输出统一风格的文档。所有人都使用同样的样式文件,这样能得到风格一致的输出物(PDF)。传统是使用文档模板来辅助人们按照一定的规则写作,不过它不是强制的,也无法检查内容是否符合某个规则。
2024-07-30 09:31:21 342
原创 如何写好技术文档 - 来自Google十多年的文档经验
写文档有一个很常见的错误,那就是很多人文档都是写给自己看的,这种情况下就会导致你的文档只有自己或者和你有相似知识背景的人才能看懂,团队较小时这种问题还好,你们都做着类似的工作,所以也都能看懂文档。虽然很多工程师都讨厌冗余 极力追求简洁,但写文档和写代码不同,适当的冗余反而可以帮助读者理解,很简单,举个例子,比如写作中经常举例子,举的例子本质上就是冗余信息,生动的例子肯定是能帮助读者理解抽象内容的(我想这就是自举吧)。:一般由团队里比较资深的人负责,他们关注的核心点是文档写的对不对,专不专业。
2024-07-27 12:09:33 1131
原创 Google文档工程师:我们代表用户在产品研发中发声
这是一次非常令人大开眼界的经历,和不同语言的人一起工作,不同的文化不同的背景,真正努力确保我们正确地将谷歌的产品信息发送给所有这些不同受众,并确保我们产生最大的影响。这不仅仅是在线帮助,它也可以是用户指南教程,视频培训,UI中的错误消息。我正在交付用户他们需要知道的信息,我们真的很想帮助我们的最终用户,对我们的产品有最好的体验。确保我们正在将谷歌的产品正确信息发送给所有这些不同的观众,并确保我们产生最大的影响。Hi, 我是Matt Werner,我是谷歌的一名技术作家。我叫佩吉,我是谷歌的一名技术作家。
2024-07-08 13:59:24 149
原创 如何为转DITA写作准备和培训团队
在刚刚结束的Adobe DITA World 2024大会上,Amanda博士做了《为DITA写作准备和培训团队》的分享
2024-06-24 18:23:52 264
原创 在线的、完全免费的、提供回放的技术传播方面的大会:Adobe DITA World 2024
全球最大的DITA营销和技术传播认识在线会议正在举行
2024-06-13 13:27:16 180
原创 tcworld China 2024大会分享预告:如何将Word和PDF转成高质量结构化内容,提高AI服务质量
tcworld China 2024大会分享预告:如何将Word和PDF转成高质量结构化内容,提高AI服务质量
2024-05-21 11:41:57 201
原创 恩智浦如何使用DITA
对于这些内容,我们仍然需要在发布后(手动)将内容提取到DITA中,但这是我们在不久的将来寻求自动化的事情,长期目标是将DITA作为所有自然语言内容的源格式。我们已经建立了一个部分自动化的工作流程来处理翻译请求,它原生支持DITA,并且需要最少的设置来在我们的内容和翻译提供商之间架起一座桥梁。每一个带圆圈的内容都是一个主题,它是一个离散的内容资源,可以在多个文档(或DITA中的Map)中重用。这在翻译时会带来好处,因为我们最终不会一次又一次地翻译相同的内容,从而获得更一致的翻译内容和更低的成本。
2024-04-30 11:11:46 639
原创 万字长文:带你了解华为技术传播的发展历史
本文作者李学昭老师是技术传播行业资深从业者,在华为从事相关工作多年。 李老师通过自己的分享,让国内广大同仁得以学习华为的宝贵经验,助力中国企业打造具有国际竞争力的产品和服务并走向世界,难能可贵。推荐!
2024-04-29 09:30:03 1580
原创 科林谈DITA在NXP半导体中的应用
我还发现有趣的是,他们也做了一些小的专有化,主要是为了添加内部元数据并约束内容模型—他们已经公开了这些信息,他们的DTD可以在这里找到。这是完全合理的,因为我们的词典是基于IEC61360的,而OntoML是一种有效的序列化格式。至于我在DITA方面最糟糕的经历,那是在我加入恩智浦(2010年12月)后不久发生的,当时我不得不使用一组现有的样式表来渲染PDF数据手册。对我们来说,一个标准等于很多和我们有同样问题的人,加上很多软件公司,他们在我们甚至没有询问的情况下就预测到了我们的需求。
2024-04-28 09:17:44 709
原创 资深设计师Elise谈用户体验设计
大家好,我是Elise,毕业于爱尔兰卡洛理工学院交互设计系,曾在联想和Reed Elsevier担任过资深体验设计师。在过去的工作中我积累了丰富的体验设计经验,今天和大家一起探讨用户体验设计这个在数字化时代日益重要的话题,希望对你有所帮助。随着科技的不断发展,我们的生活越来越离不开各种数字产品,无论是手机应用、网站还是智能设备,都成为了我们日常生活中不可或缺的一部分。而用户体验设计就是为了让这些产品更加人性化、更易用,让用户在使用过程中能够感受到愉快和方便。- 1 -什么是用户体验设计简单来说,
2024-04-15 09:30:35 807
原创 美国现行的文档无障碍性相关法律和行业指南
508合规要求任何与美国政府合作的联邦机构提交的电子信息必须能够被所有人使用,包括那些有残疾的人,如失明或失聪者。这是一项具有法律约束力的规定,因此,如果你与联邦机构有合作,那么确保你的文件符合这一法律要求是非常重要的。这些指导方针对当今行业的影响深远。第二级则更为全面,包括现场音频的字幕等,这意味着如果我现在和你说话,并且我的内容符合508标准,那么屏幕底部应该会有字幕,解释我正在说什么。而第三层则是最全面的合规层,它主要针对那些有重度残疾的人,如盲聋或视力严重受损者,提供增强对比度和导航等支持。
2024-04-12 10:18:27 174
原创 产品出口到欧美的朋友注意了!直播预告:北美专家分享文档的无障碍行
在这个信息爆炸的时代,文档资料已经成为了我们工作和生活中不可或缺的一部分。但是,你是否想过,对于那些视障、听障的朋友们来说,如何轻松获取和理解这些文档资料却是一个巨大的挑战。
2024-04-06 20:32:11 152
原创 怎样开发Apple Vision Pro应用?以应用开发者角度体验苹果的开发文档
苹果推出革命性产品Vision Pro。 在大家兴奋的围观之际,已经有人在规划能做些什么了。
2024-02-21 22:36:05 1156
空空如也
TA创建的收藏夹 TA关注的收藏夹
TA关注的人