技术文档写作系列(1) 漫谈技术写作

来源 :程序员 | 被引量 : 0次 | 上传用户:guoyh
下载到本地 , 更方便阅读
声明 : 本文档内容版权归属内容提供方 , 如果您对本文有版权争议 , 可与客服联系进行内容授权或下架
论文部分内容阅读
相较于国外的技术文档,国内的文档写作还有相当大的提升空间。希望通过该系列文章,唤醒国内开发者对文档的重视;同时,通过理清对比各种文档的差异,搞清楚目标读者,才能确定你不会写出无意义的文档。过去我长期担任技术编辑和技术专栏作家,阅读过国外技术文档更是不计其数。相较于国外的技术文档,我觉得国内的技术文档有相当大的进步空间,这也就 Compared to foreign technical documents, the domestic document writing there is considerable room for improvement. Hope that through this series of articles, domestic developers wake up the importance of the document; the same time, sort out the differences between various documents, understand the target audience, to be sure you will not write meaningless documents. In the past I have long served as technical editor and technical columnist, reading foreign technical documents is countless. Compared to foreign technical documents, I think there is considerable room for technical documentation in the country, which also
其他文献
泡沫酸酸化工艺技术国外已应用多年,特别在低压低渗地层处理和滤失性地层的重复酸化施工中,已取得良好结果,在石油和天然气的增产措施中,取得明显经济效益。泡沫酸为两相泡
本发明属于金属丝生产范畴,可用于金属制品工业制造合金焊条钢丝。传统的制造镀铜焊条钢丝的方法包括:半成品线材的拉拔、在控制气氛中退火、在浓度100克/升苛性钠溶液中脱
在表演学习过程中,我们观察生活,体验生活是不可或缺的一部分,戏剧艺术也正是要展现生活中的人、事、情、态,脱离了生活就很难使演员的表演达到真实可信,最终达到生活化的表
一、前言当圆柱工件用顶尖支撑进行机械加工时,顶尖与工件中心孔的接触表面作为旋转轨道,同时也承受工件的重量和切削力。在理想条件下,接触表面是由同轴的且几何形状正确的
如果风霜使您的青春黯然,如果雪雨使您的心儿憔悴,如果现代书奏中您怅然若失,如果竞争中您焦虑难平,请您走进心理咨询: If the wind and frost to make your youth sad, if
本文用余瑞璜先生的“固体与分子经验电子理论”计算了工业牌号的50、50Cr、50CrV钢奥氏体的价电子结构,从原子杂化状态、共价键力大小的价电子深度,讨论了合金相的价电子结
为适应国内大电机发展的需要,武钢进行了低铁损无取向硅钢 W_(09)的研制并在哈尔滨电机厂20万千瓦汽轮发电机机组上试用。目前我国无取向硅钢生产最高牌号为W_(10)(0.50mm,P
国际经济贸易的战略态势 在新技术革命的影响下,国际经济贸易的战略态势,正在促发新的变化,新战略态势正在加速地代替旧的战略态势,首先是: 一、旧的不平衡引起新的不平衡—
我厂最近与美国AEC公司试制G1012M1型塑料粉碎机,目前国内还没有这种产品。在美国废塑料都是在冷态下采用塑料粉碎机进行粉碎后而回收,在国内是将废的塑料加热熔化而回收。
本文从主轴部件在机床中的功能及其重要位置出发,提出对机床主轴部件的基本要求。在这基础上讨论了如何提高主轴部件精度这一主轴部件设计中的关键问题。 In this paper, st