テクニカルライティングチームの仕事についてまとめる。テクニカルライティングチームを作りたい開発チームを想定し、「テクニカルライティングチーム」の役割を概観する。2021年3月現在の情報として。
＊一部、ライティングを超えた「テクニカルコミュニケーション」についても網羅する。
よくあるお悩み
-
社内文書作成が属人的である。
- 量や巧拙がまちまちである。
- 用語の用法がまちまちである。
- 用語の理解がまちまちである。
- 技術文書を書く基本知識がない。
- 文書整頓されていない。
- 退職した人の資料が見つからない。
- 体系立てて書けていない。
- 量や巧拙がまちまちである。
-
プログラムの開発者が専門ライティングまで担うには重荷である。
- プログラム開発工数がライティングに消費されてしまう。
- 決まりきった文書にはテンプレートがほしい。
- 「です、ます」体や時制の統一など、ガイドに則った細かい校正は開発者が担う必要はない。
- より多くの人に読んでもらうことを想定した文書に専門家が必要である。
- 役割分担が必要である。
- プログラム開発工数がライティングに消費されてしまう。
- 社内文書が陳腐化してしまう。
-
外部公開する文書を洗練させたい。
- その他
解決策: テクニカルライティングチームのお仕事
-
社内外、ユーザーに向けた文書や素材の構造化、編集
- 編集、加工
- 校正
- テンプレート作成
- 教育コンテンツ作成
- ムービー作成
- その他
-
教育
- ライティング講座
- 開発者がドラフトをうまく作成できるように教育
- ツールやテンプレートについての教育
- その他
- 社内外の技術情報収集、試用
- 作成された文書のレビュー、編集
-
翻訳
- 様々な言語でやり取りされている状況で、文書でコミュニケーションができるようにサポート
- ローカライズ支援
参考: 以下のような各社事例
日立インフォメーションエンジニアリング
- マニュアル制作
- 製品・サービスのマニュアル制作
- 業務システムのマニュアル制作
- マニュアル改善コンサルティング
- システム導入時の操作研修
- 文章品質の向上支援（校正・校閲）
- ドキュメント制作トータル・ソリューション・サービス
- Web制作
- Webサイト制作／Webサイト保守
- SharePointサイト制作
- モバイル対応Webサイト制作
- グローバル対応Webサイト制作
- プロモーションデザイン
- プレゼン資料制作
- 動画制作
- カタログ／リーフレット制作
- イベントプロモーション
- GUIデザイン
- 操作フロー・画面設計
- アイコン・ビジュアルデザイン
- 翻訳
- 翻訳
- 中国語翻訳サービスのご紹介
- 英文・中文リライト
- ソフトウェアのローカライズ支援
- 英文・中文評価
- 教育・研修
- テクニカルライティング講座
- 技術文書の指導ポイント講座
- eラーニング教材制作
- eラーニングコンテンツの制作
- 画面操作ムービーの制作
- 設計ドキュメントの品質向上支援
LINE
LINEの社内には「テクニカルライティング」の専門チームがあります
テクニカルライター / Japanese documents
- サードパーティ向けにエンジニアが作成したドラフトをレビュー・再構築し、Webで閲覧できるように編集、加工
- 様々な言語でやり取りされている社内で、共通の文書でコミュニケーションができるようにサポート
- エンジニアがドラフトをうまく作成できるように教育（ライティングに関連するツールやシステムについての教育を含む）
- 社内外、利用者に向けた文書の構造化、編集
- 開発者向けのプロダクトの情報収集、テスト
- 作成された開発文書のレビュー、編集
- LINE Developers https://developers.line.biz/ で公開している文書の編集、管理
- LINE Biz Partnerに提供する文書の編集、管理
サイボウズ
- エンジニアと密なコミュニケーションを行い、サービスの仕様を把握する
- 製品によって、仕様書は英語の場合もあります。また、海外拠点のメンバーとの英語でのコミュニケーションも必要になります。
- プロダクトマネージャーとサービスの利用者のイメージをすり合わせて、適切なUI文言の選定、およびヘルプ記事の執筆を行う
- 作成したヘルプ記事のレビューをプロダクトマネージャー、QAエンジニアなどに依頼し、受けたフィードバックを反映する
- UI文言・ヘルプ記事の翻訳を、チーム内の翻訳者や翻訳会社に依頼する
Amazon
Technical Writer (以下翻訳)
- 文章、口頭、視覚的なコミュニケーションスキルを駆使して、推奨プログラムのサポートを得る。
- あらゆるレベルの顧客と協力して要件やフィードバックを収集し、目的を定義して結果を出す。
- 技術的な内容の編集、ドキュメントの構造やプロセスの改善の提案など、チームメイトやお客様と協力してドキュメントの品質を向上させる。
- プロジェクト、課題、ソリューション、戦略について、リーダーやステークホルダーにプレゼンテーションを行い、会話をリードする。
- 優先順位付けを行い、組織のあらゆるレベルで明確なコミュニケーションをとる。
- プログラムスポンサーと協力して、プログラム戦略と主要なパフォーマンス指標を定義する。
- 大量のデータを見つけて分析し、コンテンツインテークチームが顧客に焦点を当てた意思決定を行うのに役立つ実用的なインサイトを作成する。
- プログラム指標に対する進捗状況を把握するための指標を導入し、進捗状況を毎月報告し、年間目標を設定する。
- ポートフォリオプログラムのドキュメント、ダッシュボード、コミュニケーション資料の作成と管理
Apple
Technical Writer (翻訳)
- お客様の言葉で語りかけるような、明確でシンプルなコンテンツの作成
- フォーマットやビジュアルでコンテンツを改善する方法を提案する
- 同僚に建設的なフィードバックを与え、自分の仕事を他の人と一緒に確認する
- さまざまなパートナーとのオープンで効率的なコラボレーション
- コンテンツストラテジストとの協働により、パフォーマンスの低いコンテンツを分析し、改善方法を提案する
- コンテンツプロジェクトを処理し、状況を積極的に伝える
- 自分のコンテンツをより良くする方法を模索し、常に水準を高めていく
Becoming a Technical Writer at Google (翻訳)
- 英語で明確に書く。私たちは、英語が第一言語であるか、第十言語であるかは気にしません。私たちが気にするのは、英語で書かれた文章の質だけです。
- 複雑な技術を比較的早く学ぶことができる。
- 複雑な技術を、対象となる人々にとって有益な方法で説明することができる。
- 強力な対人関係スキルを持っている。
- コードを理解することができる。
- 社内外のエンジニアを対象とした技術文書の企画、作成、維持管理。
- 他者が作成したドキュメントの編集、明確化、校正、およびライターではない人のライティングスキル向上のためのコーチング。
- 複雑なドキュメントプロジェクトを管理する。
- 関連するサンプルコードで開発者のドキュメントを補足する。
補足: テクニカルコミュニケーター協会
その他資料
ドキュメント作成スキル向上を目指す人向けおすすめ記事まとめ
分かりやすいドキュメントを書く「テクニカルライター」という仕事
これだけ気を付けて書いてもらえるとみんな幸せになるポイント2つだけ
LINEの社内には「テクニカルライティング」の専門チームがあります - LINE ENGINEERING
(そもそも) テクニカルライティングとは
拙著参考: 比較 - テクニカルライティング・クリエイティブライティング
スタイルガイド
- 日本語スタイルガイド
- 日本翻訳連盟(JTF)日本語標準スタイルガイド
- 日本語文章のスタイルガイドのまとめ
- JTF日本語標準スタイルガイドのルールセットで文章をチェック
-
Google社のテクニカルライティングの基礎教育資料がとても良かったので紹介したい
-
Technical writing resources | Google Developers
- This style guide provides a set of editorial guidelines for anyone writing developer documentation for Google-related projects.
-
Welcome - Microsoft Style Guide | Microsoft Docs
- Welcome to the Microsoft Writing Style Guide, your guide to writing style and terminology for all communication—whether an app, a website, or a white paper. If you write about computer technology, this guide is for you.
-
Technical writing resources | Google Developers
まとめ
以上、「テクニカルライティングチーム」が開発チームの一端として冒頭のような課題解決を担うには、どういったことが必要か考え、まとめた。参考になればさいわいです。
コメント