先輩ライターに訊く、技術文書執筆のアレコレ 先輩ライターに訊く、技術文書執筆のアレコレ(1)~花井志生(宇野るいも)さん 技術文書執筆の現場(1) 花井 志生(ペンネーム 宇野るいも)[著] 2011/09/26 14:00 コラム ポスト 目次 Page 1 1 はじめに 1.1 企画の背景 1.2 この連載で提供したいこと Page 2 2 執筆者紹介(共通の質問項目) 2.1 筆者プロフィール 2.2 代表的な執筆の成果物を教えてください 2.3 そのような執筆活動を行うようになった切っ掛けを教えてください 2.4 執筆活動のモチベーション(or やってよかったこと)は何ですか? 2.5 個人的に理想としている筆者、文章などはありますか? 2.6 執筆における失敗談、ブレイクスルーなどがあれば教えてください Page 3 3 技術解説文書の種類 3.1 テーマの選択 3.2 BCGマトリクス 3.3 合わせ技 3.4 紹介系文書を執筆する 3.5 know-how系文書を執筆する 3.6 その道の専門家が良い解説文書を書けるわけではない Page 4 4 執筆作業の実際 4.1 開発プロジェクトと比べると 4.2 執筆の実際 4.3 スケジュールを守るために 4.4 自分の売り込み 5 最後に 会員登録無料すると、続きをお読みいただけます 新規会員登録無料のご案内 ・全ての過去記事が閲覧できます ・会員限定メルマガを受信できます メールバックナンバー 新規会員登録無料 ログイン Page 1 1 はじめに 1.1 企画の背景 1.2 この連載で提供したいこと Page 2 2 執筆者紹介(共通の質問項目) 2.1 筆者プロフィール 2.2 代表的な執筆の成果物を教えてください 2.3 そのような執筆活動を行うようになった切っ掛けを教えてください 2.4 執筆活動のモチベーション(or やってよかったこと)は何ですか? 2.5 個人的に理想としている筆者、文章などはありますか? 2.6 執筆における失敗談、ブレイクスルーなどがあれば教えてください Page 3 3 技術解説文書の種類 3.1 テーマの選択 3.2 BCGマトリクス 3.3 合わせ技 3.4 紹介系文書を執筆する 3.5 know-how系文書を執筆する 3.6 その道の専門家が良い解説文書を書けるわけではない Page 4 4 執筆作業の実際 4.1 開発プロジェクトと比べると 4.2 執筆の実際 4.3 スケジュールを守るために 4.4 自分の売り込み 5 最後に 次のページ3 技術解説文書の種類 1 2 3 4 PREV NEXT この記事は参考になりましたか? 0参考になった 印刷用を表示 ポスト 先輩ライターに訊く、技術文書執筆のアレコレ連載記事一覧 先輩ライターに訊く、技術文書執筆のアレコレ(3) ~初心者向けの技術文書/合田英二さん 先輩ライターに訊く、技術文書執筆のアレコレ(2) ~チーム執筆/須江信洋さん 先輩ライターに訊く、技術文書執筆のアレコレ(1) ~花井志生(宇野るいも)さん もっと読む この記事の著者 花井 志生(ペンネーム 宇野るいも)(ハナイ シセイ(ペンネーム ウノルイモ)) ※プロフィールは、執筆時点、または直近の記事の寄稿時点での内容です この著者の最近の執筆記事 この記事は参考になりましたか? 0 参考になった この記事をシェア ポスト シェア CodeZine(コードジン) codezine.jp https://codezine.jp/static/common/images/czlogo4fb_ogp.png https://codezine.jp/article/detail/6165 2011/09/26 14:00 Special Contents AD キャリアインタビュー AD おすすめ アクセスランキング 1 今後生成AIとどう向き合うべきなのか? 現場のエンジニアと研究者が最新研究事例から語り合う 2 GitHub Copilotを使用して作成されたコード、機能性、可読性、信頼性、保守性、簡潔さが向上していることが明らかに 3 Vue.js3.4~3.5の新機能をまとめて紹介! 新しいAPIやSSRの改善 NEW 4 エンジニア向けプログラミング専門タイピング練習ゲーム「UnTyping」に「Java コース」が追加 5 Microsoft、Microsoft 365の新たなエージェントを「Microsoft Ignite」にて発表 6 Python 3.13の新機能、対話型インタプリタの機能強化や高速化などを解説 7 VSCodeをドキュメント作成に活用――テキストエディタ、Markdownエディタの設定と拡張機能を解説 8 ノーコードAIツール「MatrixFlow」、生成AIの精度を向上する「RAG」機能と「プロンプト管理」機能の提供を開始 9 女性エンジニアに聞いた「フェアに働けそうなイメージのある企業ランキング2024」上位18社を発表、WAKE Careerが調査 NEW 10 日立製作所、OSS活用をグローバルでリードするOpen Source Program Office(日立OSPO)を設立 アクセスランキング 今日 月間 1 今後生成AIとどう向き合うべきなのか? 現場のエンジニアと研究者が最新研究事例から語り合う 2 GitHub Copilotを使用して作成されたコード、機能性、可読性、信頼性、保守性、簡潔さが向上していることが明らかに 3 Vue.js3.4~3.5の新機能をまとめて紹介! 新しいAPIやSSRの改善 NEW 4 エンジニア向けプログラミング専門タイピング練習ゲーム「UnTyping」に「Java コース」が追加 5 Microsoft、Microsoft 365の新たなエージェントを「Microsoft Ignite」にて発表 6 Python 3.13の新機能、対話型インタプリタの機能強化や高速化などを解説 7 VSCodeをドキュメント作成に活用――テキストエディタ、Markdownエディタの設定と拡張機能を解説 8 ノーコードAIツール「MatrixFlow」、生成AIの精度を向上する「RAG」機能と「プロンプト管理」機能の提供を開始 9 女性エンジニアに聞いた「フェアに働けそうなイメージのある企業ランキング2024」上位18社を発表、WAKE Careerが調査 NEW 10 日立製作所、OSS活用をグローバルでリードするOpen Source Program Office(日立OSPO)を設立 1 VSCodeをドキュメント作成に活用――テキストエディタ、Markdownエディタの設定と拡張機能を解説 2 生成AI時代のソフトウェアテストは「めんどくさい」── 高橋寿一氏が語る、これからの「シフトレフト」「シフトライト」 3 Python 3.13の新機能、対話型インタプリタの機能強化や高速化などを解説 4 なぜバックエンド開発にRustを使うのか? その魅力はパフォーマンス、安全性、生産性の高さ 5 DMM.comの施策から見る、事業をむしばむ「技術負債」への処方箋──リファクタリングの「言語化」でインシデントを予防 6 高パフォーマンスなコードを書くために不可欠の知識、『なっとく! 並行処理プログラミング』発売 7 Pythonや生成AI活用など無料で基礎が学べるプログラミング学習講座「スタディングテック」提供開始 8 PHPパッケージ管理ツール「Composer」の処理の仕組みを見てみよう! 9 フリーランスエンジニアに求められる能力とは? ギークスが調査レポートを発表 10 テスト自動化ツールの導入で発生する課題……事例と共に、業界20年のベテランが解消方法を解説! イベント CodeZine編集部では、現場で活躍するデベロッパーをスターにするためのカンファレンス「Developers Summit」や、エンジニアの生きざまをブーストするためのイベント「Developers Boost」など、さまざまなカンファレンスを企画・運営しています。 新規会員登録無料のご案内 ・全ての過去記事が閲覧できます ・会員限定メルマガを受信できます メールバックナンバー 新規会員登録無料 ログイン アクセスランキング 1 今後生成AIとどう向き合うべきなのか? 現場のエンジニアと研究者が最新研究事例から語り合う 2 GitHub Copilotを使用して作成されたコード、機能性、可読性、信頼性、保守性、簡潔さが向上していることが明らかに 3 Vue.js3.4~3.5の新機能をまとめて紹介! 新しいAPIやSSRの改善 NEW 4 エンジニア向けプログラミング専門タイピング練習ゲーム「UnTyping」に「Java コース」が追加 5 Microsoft、Microsoft 365の新たなエージェントを「Microsoft Ignite」にて発表 6 Python 3.13の新機能、対話型インタプリタの機能強化や高速化などを解説 7 VSCodeをドキュメント作成に活用――テキストエディタ、Markdownエディタの設定と拡張機能を解説 8 ノーコードAIツール「MatrixFlow」、生成AIの精度を向上する「RAG」機能と「プロンプト管理」機能の提供を開始 9 女性エンジニアに聞いた「フェアに働けそうなイメージのある企業ランキング2024」上位18社を発表、WAKE Careerが調査 NEW 10 日立製作所、OSS活用をグローバルでリードするOpen Source Program Office(日立OSPO)を設立 アクセスランキング 今日 月間 1 今後生成AIとどう向き合うべきなのか? 現場のエンジニアと研究者が最新研究事例から語り合う 2 GitHub Copilotを使用して作成されたコード、機能性、可読性、信頼性、保守性、簡潔さが向上していることが明らかに 3 Vue.js3.4~3.5の新機能をまとめて紹介! 新しいAPIやSSRの改善 NEW 4 エンジニア向けプログラミング専門タイピング練習ゲーム「UnTyping」に「Java コース」が追加 5 Microsoft、Microsoft 365の新たなエージェントを「Microsoft Ignite」にて発表 6 Python 3.13の新機能、対話型インタプリタの機能強化や高速化などを解説 7 VSCodeをドキュメント作成に活用――テキストエディタ、Markdownエディタの設定と拡張機能を解説 8 ノーコードAIツール「MatrixFlow」、生成AIの精度を向上する「RAG」機能と「プロンプト管理」機能の提供を開始 9 女性エンジニアに聞いた「フェアに働けそうなイメージのある企業ランキング2024」上位18社を発表、WAKE Careerが調査 NEW 10 日立製作所、OSS活用をグローバルでリードするOpen Source Program Office(日立OSPO)を設立 1 VSCodeをドキュメント作成に活用――テキストエディタ、Markdownエディタの設定と拡張機能を解説 2 生成AI時代のソフトウェアテストは「めんどくさい」── 高橋寿一氏が語る、これからの「シフトレフト」「シフトライト」 3 Python 3.13の新機能、対話型インタプリタの機能強化や高速化などを解説 4 なぜバックエンド開発にRustを使うのか? その魅力はパフォーマンス、安全性、生産性の高さ 5 DMM.comの施策から見る、事業をむしばむ「技術負債」への処方箋──リファクタリングの「言語化」でインシデントを予防 6 高パフォーマンスなコードを書くために不可欠の知識、『なっとく! 並行処理プログラミング』発売 7 Pythonや生成AI活用など無料で基礎が学べるプログラミング学習講座「スタディングテック」提供開始 8 PHPパッケージ管理ツール「Composer」の処理の仕組みを見てみよう! 9 フリーランスエンジニアに求められる能力とは? ギークスが調査レポートを発表 10 テスト自動化ツールの導入で発生する課題……事例と共に、業界20年のベテランが解消方法を解説!