テクニカルライティングガイドラインを公開しました | フューチャー技術ブログ

はじめに流通事業部の内堀です。 フューチャー社内の有志メンバーでテクニカルライティングガイドラインを作成し公開しました！ 設計書、Pull Requestの説明、Slackでの相談、障害の一次報告。ITコンサルタントの仕事は、文章を書くことと切り離せません。本ガイドラインが対象にするのは、こうした日々の文章そのものです。専門的な概念を構造化し、判断に足る情報を示して意思決定を推進するための技術をまとめました。 本記事では、ガイドライン作成の背景と全体像、そして内容の一部を抜粋して紹介します。 なぜテクニカルライティングをガイドライン化したのか本ガイドラインは、これまで個人のセンス頼みだった「説明力」を、誰でも参照できる形式知へと落とし込むために作成しました。 こんな場面に心当たりはないでしょうか。 丁寧な状況共有をもらったが、結局自分が何をすればいいのか分からず「で、何をしてほしいの？」と

[aquarickn]

こういうガイドラインはありがたい。Codexに読み込ませてSkill化させてもらった。

[LM-7]

テクニカルライティングに限らない。メールなどは全てのこのガイドラインを意識してほしい

[boyarin]

テクニカルライターで10年以上働いていて思ったが、どの仕事でもこの文章スタイルは学んでほしい。大して難しいものじゃないから高校生くらいのカリキュラムに入れてほしい。

[MacRocco]

俺のAIエージェントに食べさせたい

[atsuchickun]

仕事