文書作成標準 / 文書の目的

文書作成標準

ビジネス文書や開発ドキュメントを作成するにあたっての標準化にあたって考えるべき事。

  • 標準化する目的を明確にする。
  • 目的に沿ってルール、推奨、指標を明記した文書を作成する。
  • 同文書の内容について関係者全員のコンセンサスを得る。
  • 同文書を公布する。
  • 定期的に見直しを行う。

ここまでで標準化のプロセスが完了。標準化プロセスについては本一冊を費やす内容だと思うのでそれらを参照する。

より具体的な話。例として次のようなルール、推奨、指標を作る。

  • 原則として文書作成はWORD、表等はEXCELを用いて作成する。
  • 共通事項
    • 印刷されることを意識する。印刷確認を行う。
    • 文書は表紙と目次と履歴と内容から成る。
    • ヘッダ、フッタにそれぞれファイル名、更新日時、ページ番号をつける。ある一ページを抜き出して、それがどのファイルのどのバージョンのどのページであるか判断できる。
    • 見出し、図、表にはそれぞれ見出し番号、図番号、表番号をつける。
    • 表には見出しと項番をつける。
    • 表紙は文書名、作成日時、作成者から成る。
    • 履歴は更新日時、更新箇所、更新内容、更新理由、更新者から成る。
  • WORD
    • 構造化文書となるよう意識する。
    • スタイルを用いる。
  • EXCEL
    • 印刷した際、セルが途切れないように意識する。

WORD、EXCELそれぞれに基準となるファイルがあると親切だろう。

標準化団体等が策定している規則や、論文の規則等、一般的なビジネス文書の書き方等を流用して自分用にカスタマイズする方が自分で作るより標準的で簡単。

このくらいならビジネスマナーレベルなので、開発文書であればそれ特有の規則を別途設ける必要があるだろう。

思いついたら追記修正する。

参考

文書の目的

たいていの文書の最大の目的は「伝えること」である。

加えて以下のような条件がつく

  • 正しく伝わること
    • そのために曖昧な表現を避けること
  • 過不足無く伝わること
    • 多すぎても少なすぎてもいけない

バランス感覚とセンスと経験が問われるが、それらは個人に依存するため、標準を明記した文書が必要となる。

最終更新時刻: 2008年11月07日

HP DL360 G5をキッティング中 / RedHat Enterprise Linux 5のyumがRedHat Networkからパッケージを取得しない

HP DL360 G5をキッティング中

某用途向け仮想環境用に、HP DL380 G5をキッティング中。

追加パーツは下記。

  • CPU Xeon E5430 2.66GHz
  • メモリ 2GB
  • リダンダントパワーサプライ
  • DVD-ROMドライブ
  • SASディスク146GB×4

総スペックとしてはこんな感じ。

  • CPU Xeon E5430 2.66GHz × 2(計8コア)
  • メモリ 4GB(1GB×4)
  • リダンダントパワーサプライ × 2
  • SASディスク146GB×4(3本でRAID5構成、1本はホットスペア)

仮想環境としてはメモリ容量が心許ないけど、まだスロットが4本余ってるので後々拡張余地は有り。

RedHat Enterprise Linux 5のyumがRedHat Networkからパッケージを取得しない

RHEL5からはup2dateに変わってyumが採用されている。

インストール後、とりあえずopenssh-serverパッケージをインストールしようとしたところ失敗。「そんなパッケージはありません」と言われる。

# yum install openssh-server

まずは、下記を確認。

  • RHNのサイトに対象サーバが正常に登録されているか。
  • ソフトウェアアップデーターを使って登録を行い、RHNのサイトで同ホストが登録されていることを確認した。

結論としては「yum-rhn-plugin」がインストールされていなかったことが原因。

CD1より上記パッケージをインストールしたところ無事実行できた。

今回始めてテクニカルサポートを受けたんだが、そもそもCentOSなら上記症状にはならなかったんだよね…。

ググっても情報少ないし、やっぱり今度からCentOSにしたいな(;・∀・)

最終更新時刻: 2008年08月21日