【社内資料公開】運用手順書を作る時のポイントについて書いてみた | DevelopersIO
はじめに こんにちは植木和樹＠上越妙高オフィスです。本日は私がここ10年くらい意識している運用手順書を書くときのポイントについてまとめてみました。 対象読者 開発・構築したシステムを別の人に引き継ぐ予定のある人 他の人が作ったシステムを引き継ぐ担当の人 半年後の自分でも分かる手順書の書き方に困っている人 （この記事を読むのにかかる時間の目安：5分） 1. ドキュメントの冒頭に書くこと まず個々の詳細手順の前に、ドキュメント自体について記載してもらいたいことです。 1.1. ドキュメントに書かれていることを3行で書く ドキュメントの最初には、このドキュメントに何が書かれているのかを100文字くらいで書いておくと良いでしょう。 システムが増えれば増えるほど手順書も増えていくものです。見つけたドキュメントに自分の期待するものが書かれているのか、冒頭数行でわかるようになっているとうれしいです。 1
テクニカルライティング（Technical writing） | 福山産業翻訳センター
テクニカルライティングは、叙情的であってはなりません。アメリカのビッグ企業では、テクニカルライティング部があり、社外に配布するすべての文書 を専門的に作成しています。単なる担当者が作成した文書が特に社内の校閲/精査を受けないで社外に配布される時のリスクを非常に重大なものとして捕らえて おります。特に米国の場合には、ご承知のように製造物責任制度が厳しいので、社外に配布する文書には神経を使っているのです。例えば、ある担当者が特に重 要であると考えずに配布した書類で何らかの約束、保証等を与えるような内容が伺えると、それが一般に対する”明示の保証”となって、後々不都合が生じる可能性があるからです。 このテクニカルライティングとはいわゆる”技術文書を書く”ということだけでなく、専門的な文書をすべて網羅するということです。従って、企業がある目的 を持って配布する文書はすべてテクニカルライティングの範疇
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
