初学者的技术写作:技术博客基础知识AZ指南程序员张张

如果你喜欢写作和技术,技术写作可能是一个适合你的职业。如果你喜欢技术,但又不是真的整天喜欢编码,也可以做一些别的事情。

如果你喜欢通过教导他人来学习,为开源项目做出贡献,并教导他人如何做到这一点,或者基本上喜欢通过你的写作以简单的方式解释复杂的概念,技术写作也可能适合你。

让我们深入了解基础知识,了解你在开始技术写作时应该知道和考虑的问题。

技术写作是一门艺术,提供细节导向的指导,以帮助用户理解特定的技能或产品。

技术写作者的交流方式是将技术信息呈现给读者,使读者能够将这些信息用于预期的目的。

技术写作者也是是终身学习者。由于这份工作需要用简单而直接的术语来表达复杂的概念,所以你必须精通你所写的领域,或者愿意学习它。

这很好,因为每研究和编写一份新的技术文档,你就会成为该领域的专家。

除此以外,你还可以为开源社区做贡献,参与GoogleSeasonofDocs和Outreachy等付费开源项目。

你也可以把技术写作作为一个全职职业——很多公司都需要有这些技能的人。

知道如何实现功能并不一定意味着你可以与其他人清楚地交流该过程。

为了成为一名优秀的老师,你必须具有同理心,能够以适合你的目标受众的方式教授或描述术语。

我相信,作家是天生的,而不是后天的,而你只有通过实际写作才能学会如何写作。

你可能永远都不知道你有写作的能力,直到你把笔放到纸上。而要想知道自己是否有一定的写作能力,只有一个办法,那就是通过写作。

所以我鼓励你从今天开始写作。你可以选择从我在本节中列出的任何一个平台开始,以扩展你的写作能力。

当然,拥有一些技术领域的经验也是巨大的好处。

你还可以加入有用资源的链接,这样你的读者只需点击一下就能获得他们需要的信息。

为了知道你是为谁而写,你必须尽可能多地收集关于谁将使用该文件的信息。

重要的是要知道你的读者是否在该领域有专业知识,是否这个话题对他们来说是全新的,或者他们是否介于两者之间。

你的读者也会有他们自己的期望和需求。当读者开始阅读文档时,你必须确定他们在寻找什么,以及他们将从中获得什么。

要了解你的读者,请在开始写作之前先问自己以下几个问题:

这些问题还能帮助你思考读者在阅读你的写作时的体验,这一点我们现在要多说几句。

用户体验在技术文档中和在网络上的任何地方一样重要。

既然你知道了你的受众和他们的需求,就要记住文档本身是如何为他们的需求服务的。很容易忽略读者实际会如何使用文档。

写作时,不断后退一步,把自己当成读者来看待文档。问问自己:它是可访问的吗?你的读者将如何使用它?他们何时会使用它?是否易于阅读?

目的是编写一个对读者有用和可用的文档。

记住你的用户是谁,然后你就可以对你的文档进行构思和规划。

这个过程包括许多步骤,我们现在将继续进行。

在规划你的文档时,你必须研究你要写的主题。有大量的资源只需在谷歌上搜索一下就可以供你消费,并从中获得更深的见解。

尽可能多地使用谷歌,从研究期刊、书籍或新闻中获取事实和数据,尽可能多地收集有关你的主题的信息。然后你就可以开始做一个大纲了。

在扩展文档内容之前先列出提纲,这有助于你更专注地写作。它还可以让你组织你的思路,实现你的写作目标。

在确定需要嵌入到文档不同部分的各种虚拟辅助工具(信息图、gif、视频、tweet)时,有一个大纲非常有用。

终于,你可以开始写作了!如果你已经完成了所有这些步骤,写作应该会变得容易很多。但你仍然需要确保你的写作风格适合技术文档。

写作需要通俗易懂、直接和专业,在技术文档中不欢迎花哨或情绪化的文本。为了帮助你保持这种风格,这里有一些你应该培养的关键品质。

主动语态是指句子的主语是主动执行动词动作的人,被动语态是指主语是动词动作的接受者。

这是一个被动语态的示例:每个Web开发人员每年应阅读六次文档。

下面是一个主动语态的例子:每个web开发人员一年应该阅读该文档6次。

词语选择很重要,确保你使用最适合上下文的词汇。避免过度使用代词,如“它”和“这”,因为读者可能难以识别它们指的是哪个名词。

还要避免使用俚语和粗俗的语言——请记住,你是在为更多的读者写作,他们的性格和文化倾向可能与你不同。

如果你是你所在领域的专家,很容易使用你熟悉的行话,而没有意识到它可能会让其他读者感到困惑。

你还应该避免使用以前没有解释过的首字母缩写词,这是一个例子:

改进:渐进式网络应用(PWA)是真正的多平台开发的未来。它们在Android和iOS上的可用性使PWA成为未来的应用。

避免使用冗长的大词,总是尽量以最清晰的方式解释概念和术语。

一堆文字很难读懂,即使是最清晰的指令也可能在视觉表现不佳的文档中丢失。

他们说,一张图片胜过千言万语,即使在技术写作中也是如此。

但是,并非任何图像都可以配上,仅用文本表达技术信息是困难的,放置恰当的图像或图表可以澄清你的解释。

人们也喜欢视觉效果,所以把它们插入到正确的位置是有帮助的。看看下面的图片:

首先,这是一个没有视觉效果的博客片段:

这是同一博客的片段,但带有视觉效果:

贴心的格式、模板和图片或图表也会让你的文字对读者更有帮助。

既然你已经决定开始从事技术写作,这里有一些不错的平台,你可以在那里免费发布技术内容。他们还可以帮助你建立一个吸引未来雇主的投资组合。

你的申请可能被接受,也可能被拒绝,但不要灰心。你总是可以在以后重新申请,因为你变得更好,谁知道呢?你可能会被录取。

就像其他领域一样,技术写作也有各种流程、规则、最佳实践等。

参加技术写作的课程会帮助你完成你需要学习的每一件事,也可以给你很大的信心,开启你的写作之旅。

你可以查看以下一些技术写作课程:

成为一个社区或论坛的一部分,与那些和你有同样热情的人一起是有益的。你可以得到反馈、纠正、技巧,甚至从社区中的其他作家那里学习一些风格技巧。

以下是一些社区和论坛供你加入:

在我的技术写作之旅中,我跟随了一些伟大的技术作家,他们的写作之旅、一致性和风格都激励着我。

这些都是我仰望的作家,他们被我视为技术写作的虚拟导师。有时,他们会给我一些技术写作技巧,我觉得很有帮助,也从他们那里学到了很多东西。

以下是其中一些作家(与他们的Twitter超链接):

你不需要技术写作的学位就可以开始发布技术内容。你可以开始在你的个人博客和公共GitHub知识库上写作,同时构建你的作品集并获得实践经验。

真的——开始写吧。

通过为现有程序或项目创建新的文档来练习。GitHub上有很多开源项目,你可以查看并添加到他们的文档中。

技术作家一直在学习。通过深入到新的主题领域,并接受外部反馈,一个优秀的作家永远不会停止磨练自己的技艺。

当然,优秀的作家也是贪婪的读者。通过检查大量阅读和使用的文档,你的写作能力肯定会得到提高。

THE END
1.公文写作基础知识试题及答案公文写作题型及答题技巧解析公文写作一直是事业单位备考的重点和难点,考查内容主要包括公文格式、适用范围、写作方法等。通过对参考内容的分析,我们可以看出公文写作主要考查通知、请示、报告、函四种文种,这些文种的格式和适用范围是重点。在答题时,要根据给出的材料确定文种,然后确定行文格式和要点。书写时要注意格式的正确性,内容的连贯性。本文将https://www.66offer.com/146821.html
2.新闻写作技巧与基础知识20230616204108.ppt新闻写作技巧与基础知识.ppt,新闻写作技巧与基础知识苏 柳 2011.10.18 新闻的定义 在我国新闻学术界,最权威的新闻定义,是1943年陆定一提出的,“新闻的定义,就是新近发生事实的报道。”范长江也对新闻下了一个定义,“新闻就是广大群众欲知应知而未知的重要事实”。王中https://max.book118.com/html/2023/0616/8002054113005101.shtm
3.公共基础知识写作技巧公基大作文也即公共基础知识中的文章写作部分,你对公共基础知识写作技巧知道多少呢?以下是由小编整理关于公共基础知识写作技巧的内容,希望大家喜欢! 一、从写作内容角度上看。 公基作文一般是议论性质的文章,字数一般要求在800--1200字之间。 公基作文要求结合材料进行写作,属于材料作文类,考生不能脱离材料自行写作。 https://www.wenshubang.com/shenghuo/470384.html
4.英语语法基础知识与写作基本技巧常用写作语法英语语法基础知识与写作基本技巧 1.句子结构 1.1 结构种类 主谓 主谓宾:谓语是“实义动词” 主谓表:谓语是“系动词” 主谓双宾 主谓宾宾补 tips \text{tips}tips:注意时态 1.2 系动词 状态:be \text{be}be动词 感官:look, sound, taste, smell, feel \text{look, sound, taste, smell, feel}look, https://blog.csdn.net/m0_45255276/article/details/127102998
5.写作基础入门知识9篇(全文)写作基础入门知识 第2篇 公文写作基础知识 一、公文的定义和分类 定义 公文,是公务活动中所形成和使用的文字材料,是方针、政策、法规、政令和信息、情况的表现者、运载者,是机关实施管理的基本手段和重要工具,发挥着上令下达、下情上报和信息沟通的重要作用。公文贯穿机关管理工作的始终。我们要向上级报告情况,需要写https://www.99xueshu.com/w/file6wd7j17b.html
6.升学部《语文》课程知识点梳理三、方法知识(包括技能操作、标准、要求等)或典型例题(案例) 1.掌握情景交融的写作手法,在上一章《荷塘月色》的基础上进一步明确作者要表达的情感。 2.通过对作者选取意象的分析,了解在众多相关写作材料中取舍的原则:最常见的情况,选择意象通常带给人的情感倾向性与作者要表达的情绪正相关。另一种情况,利用强烈的https://www.scslyxx.cn/portal/xbjs/sxb/jpkc/webinfo/2019/09/phone1570776475683761.htm
7.语文知识点之写作技巧写作技巧就是写作中进行表现时运用的方法,是作者为表情达意而采取的有效艺术手段。写作技巧受限于作者的世界观、艺术观,同时又作用于他的写作实践,为写作活动服务。 01、?技巧一:字数三四五? 这个技巧说白了就是学习写短句。学了一段时间写作的孩子容易在作文中写长句,而长句写不好就变成病句。家长要提醒孩子https://www.meipian.cn/3l6as5qe
8.雅思写作真经总纲PDF高清电子版免费下载1. 雅思写作基础知识 该部分介绍了雅思写作的基本要求,包括字数要求、时间分配、评分标准等。通过学习这些基础知识,考生可以更好地把握雅思写作的考试形式和评分标准,从而更好地应对考试。 2. 雅思写作技巧 该部分介绍了雅思写作的一些常用技巧,例如:如何开头、如何结尾、如何组织段落等。通过学习这些技巧,考生可以更好https://www.longre.com/newsclass/detail/139710
9.常用应用写作的基本要求与方法按详细提高来写作。撰写时,观点要鲜明、突出,材料与观点相结合,材料说明观点,观点统帅材料。要正确运用表达方式和写作技巧,注意公文的语言内格和惯用模式,力求篇幅简短,语言简练,表达清楚。 (一)起草公文安排结构上的要求 1.结构的基本内容 主体结构:包括开头、结尾、层次、段落、过渡、照应六个基本要素。 (1)开头:https://www.360docs.net/doc/88b77b82bceb19e8b8f6ba60.html
10.基本文体知识识记高中语文基础知识总结高中语文基础知识大全指明语句所用的写作方法:一定要注意文体特征和名词使用的准确性。 三、问答题型、常规答题术语及技巧 回答文章中某一内容的作用可从三个方面考虑, 一是内容方面,如深化主题、强调感情等; 二是结构方面的,如过渡、呼应等; 三是语言方面,如引人入胜、生动活泼等。 1、修辞手法的作用: (1)它本身的作用;(2)结https://yuwen.chazidian.com/info288