返回首页

如何免费成为技术作家

免费掌握技术作家职业的计划,包括入门视频、documentat.io 课程、LaTeX、Markdown、HTML、Jira 学习。通过阅读和聊天发展技能。为首批职位做准备,3–4 个月。

无需课程成为技术作家:免费指南
Advertisement 728x90

# 初学者免费掌握技术作家职业的完整计划

技术作家为软件、硬件和 IT 系统创建文档、说明和指南。他们确保用户和开发者理解产品。要零投资进入这个职业,使用免费资源:YouTube 视频、课程和工具自学。完整计划需要 3–4 个月的密集工作。

初始阶段:了解角色

从入门材料开始评估这个职业的具体情况。观看视频如《职业:技术作家》、《如何成为技术作家?》和《IT 中的技术作家:期望与现实》。如果喜欢文本形式,可以阅读文章《谁是技术作家以及如何成为一名》。这些资源概述了任务,从编写 API 文档到用户指南。

本阶段任务:

Google AdInline article slot
  • 分析典型职责:创建 man pages、README 和规范。
  • 评估所需技能:结构化写作、IT 术语。
  • 确定你的动力:处理代码而无需编程。

技术文档基础课程

转向系统学习,参加 documentat.io 频道的课程《IT 项目中的技术文档》。材料涵盖:

  • 格式标准:DITA、DocBook。
  • 文档结构:目录、术语表、示例。
  • 与开发集成:链接到 Agile 流程。

课程解释了文档如何融入 CI/CD 管道,以及 Sphinx 或 MkDocs 等工具。

掌握核心技术

针对初级职位,学习 90% 技术作家招聘中使用的工具:

Google AdInline article slot
  • LaTeX:用于包含公式和图表的复杂文档。从文章/书籍类、tikz 和 listings 包的基本教程入手。
  • Markdown:README 和 GitHub 仓库的标准。掌握扩展:表格、代码块、警示框。
  • HTML:Web 文档的基础。学习语义(header、section、aside)、用于样式的 CSS。
  • Jira 和 Confluence:用于任务管理和维基。练习创建页面、宏和 Git 集成。

自行查找教程,并在个人项目上练习:为一个简单的 Python 脚本编写文档。

持续发展:阅读和社区

通过“Mishka in the Know: Technical Writer”频道扩展知识。阅读真实案例帖子:迁移遗留文档、使用 AsciiDoc 自动化。

有疑问时,加入“技术作家”聊天群。讨论:

Google AdInline article slot
  • 文档审查的最佳实践。
  • MadCap Flare 或 Paligo 等工具。
  • 面试准备:包含 3–5 个样本的作品集。

重要事项

  • 完整计划需要 3–4 个月:每周 10–15 小时。
  • 完成后,申请 IT 公司的初级职位或实习。
  • 作品集:在 GitHub 上为开源项目编写文档。
  • 面试准备:Markdown、Jira 问题,审查示例。
  • 该职业在 DevOps、SaaS 和企业产品中需求旺盛。

掌握后,即可参加面试。制作简历,附上 GitHub 文档仓库链接。

— Editorial Team

Advertisement 728x90

继续阅读