莎拉·梅(Sarah Mei)和莎拉·福克斯(Sarah Fox)以及其他一些人和我和我在Twitter上谈论的是代码学校的毕业生,以及他们在中层职位上经常表现出色的原因,因为他们具有以前的职业沟通能力。
我们都同意,教一个人写的足够好,可以成为一名专业技术作家,这可能比您在一个为期六周的密集课程中所能涵盖的更多。 取决于他们从哪里开始。 我绝对可以在6周内将一名积极进取的记者转变为入门级技术作家。 他们已经是那里的3/4了。 但是大多数人需要从头开始学习以下内容(无特定顺序):
- 受众分析
- 基于任务的写作
- 程序写作
- 用户故事编写
- 书写错误
- 错误编写
- 概念写作
- 图表,插图和屏幕截图
- 基本工具的使用
- 句子结构
- 项目符号点的使用
- 简化英语理论
- 接受编辑反馈
- 接受技术反馈
- 信息架构和表示的要素
- 可用性和可访问性的要素
- 风格指南使用
即使您来自文科/文学背景,其中的一半是您可能从未听说过的。 您可以构建一个很棒的句子,并且知道如何使用分号,但是迄今为止的经验已经使您对技术写作中无关紧要的事情有所收获。 您在发表有说服力的论据或撰写拙劣的文学评论方面都取得了不错的成绩,但是我的英语点燃课程中没有人告诉我说的是针对错误的听众或设计不好的标题。
因此,这是一个艰巨的工作,要努力使人们进入比Code Warrior少魅力的职业,让我们面对现实。 我碰巧认为这是开发团队中最好,最有影响力的地方,但这并不是薪级表所说的。
那说
就是说,我认为我可以与教学代码学校的学生和其他开发人员一起做一些真正的基本写作技能。 我今年在“编写文档”的一个研讨会上进行了尝试,效果很好。 我想在其他地方展示。 如果您有兴趣,我会将轮廓线放在剪切的下方。
给我您的开发人员一天的时间,我会教他们编写结构合理的错误代码,可读的错误报告和连贯的状态电子邮件。 给我两天时间,我将教他们有关受众群体以及分析和删除的知识。
我想在代码学校这样做,以便我们可以在人们疯狂学习时抓住他们,因此他们会记得以后再查找它。 我想对开源项目执行此操作,因为很难找到或雇用技术作家。 我想在初级开发人员希望提升他们的游戏水平的会议上这样做。 几年来,我一直在开发者大会上旅行,试图将我从职业生涯20年以来所知道的一切提炼成对编码人员有价值的东西,我坚信它是有价值的。
