タグ付けされた質問 「documentation」


30
仕事、プロセス、環境をどのように文書化しますか?
ウィキ形式を使用していますか?ある場合、どの製品ですか?(MediaWiki、Confluence、Sharepointなど) 知識ベースを作成しましたか?(問題/ソリューション指向の短いドキュメント。) 機能するドキュメントを作成する際にどんな課題がありますか。休暇中に電話をかけられませんか? 私にとっては、ドキュメンテーションの作成に関連する組織の「慣性」がある程度あることがよくあります。仕事をすることができる別の種類の人のようで、他の人ができるように彼らがどのように仕事をしたかを考えて説明してください。 更新 これまでの回答には、 合流 Flexwiki フォグバグ Mediawiki(fckeditorなどのプラグインを使用) 共有ポイント TWiki Word / Excel / Visio Docs 文書化されたスクリプト 編集:監視システムでネットワークを暗黙的に文書化していませんか?Nagiosは、常にネットワークの構造を反映する親ディレクティブの使用を推奨しており、notes_urlディレクティブは、wikiまたは他のブラウザベースのドキュメントにリンクできるように設計されています。そのため、ここで「ドキュメント」は、監視システムの「生きているドキュメント」と、ウィキ内のより詳細なオフラインドキュメントに分割されます。私はNagiosをじっと見つめるのに多くの時間を費やしているので、可能な限り有益なものにするために努力することは理にかなっています。

14
バスにひかれた場合、あなたの会社は困っていますか?
職場では、私は過去10年間で唯一のIT担当者です(すべてを実行し、今ではタイプ入力しています)。もし私がバスにぶつかったなら、彼らは完全にねじ込まれます。私はそれを経営者/社長型の人々に何度も言及しましたが、彼らは私を無視します。彼らにとっては残念です。 彼らの痛みを軽減するために私は何ができますか?(または気にする必要がありますか?) (はい、これはコミュニティwikiである必要がありますが、チェックボックスが表示されません...十分な担当者がいない可能性があります。)

6
ドキュメントの使用を開始する
私たちは職場でドキュメントを作成していません。私はまったく新しいので、始めにいくつかのガイダンスを求めます。 いくつかの質問を聞きたいんです: システム管理者が作成および保守する必要がある重要なドキュメントは何ですか?そして、なぜこれらはとても重要なのでしょうか? ドキュメントをシステムとどのように同期させますか?情報の重複をどのように最小限に抑えますか? 推奨ガイド、ベストプラクティス、アンチパターン?

9
マニュアルとしてのドキュメントとチェックリストとしてのドキュメント
過去に、部署内の他の人とドキュメント、特に詳細レベルと要件について話し合いました。彼らの見解では、ドキュメンテーションは、Xの問題が発生したときに行うYの簡単なチェックリストです。 同意しません。これは、ITのすべての問題を簡単に復旧手順の簡単なチェックリストに要約できると考えていると思います。状況の複雑さを完全に無視していると思いますし、部署の他の人たちは常に問題について深い理解を持っているわけではないので)ドキュメントには、次のような基本的な背景資料が含まれている必要があります。 問題の(サブ)システムの目的 そのように構成されている理由 設定/手順が実装されたときに発生するイベントの期待 手順が失敗する可能性のある潜在的な問題 ただし、これにはかなり賛成ですので、ドキュメントを「手順ABCを適用して問題Xを解決する」という形式に書き直す必要があります。 1ページの用紙に収める必要があるという嘆きをよく耳にします。 トラブルシューティングを含むこの方法で、Squid ACLの設定を1ページのドキュメントで説明してみてください。これは、回復チェックリストとして「作成待ち」の半ダースのドキュメントの1つにすぎません。 私が提唱している方法は本当に行き過ぎていますか?または、彼らは正しいです、そして、私はちょうどここで私のビジネスを気にして、彼らに単純なチェックリストを書くべきですか?私の懸念は、手順のチェックリストをどれだけうまく書いても、SysAdminが物事を考えることを必要とする問題を実際に解決しないことです。問題の解決に至らない回復手順のチェックリストの作成に時間を費やしている場合(ドキュメントの焦点が狭いため、ドキュメントの一部ではない追加の要因があるため)、およびドキュメントは、マニュアルページやウィキ、ウェブサイトを再度読み直すことを避けるためのものでしたが、なぜ私は動議を受けているのですか?心配しすぎているのですか、それとも本当の問題ですか? 編集: 現在、この部門にはヘルプデスクの役職はありません。ドキュメントの対象者は、他の管理者または部門長です。

5
マニュアルページを書くにはどうすればいいですか?[閉まっている]
閉じた。この質問はより集中する必要があります。現在、回答を受け付けていません。 5年前に閉鎖されました。 ロックされています。この質問とその回答はロックされています。なぜなら、質問はトピックから外れていますが、歴史的に重要だからです。現在、新しい回答やインタラクションを受け入れていません。 manページを書くにはどうすればいいですか? すべてのフォーマットコードの参照先はどこにありますか? manページの作成に関する良いチュートリアルはありますか? manページを書く最も便利な方法は何ですか?テキストエディターに直接入力する必要がありますか?WYSIWYGエディターはいますか?または、別の形式で作成してから変換する必要がありますか? 良いmanページはどのルールに従うべきですか?

5
Windowsサーバーの構成をどのように文書化しますか?
Unixのバックグラウンドから来ました。サービスの構成(たとえばメール)を文書化するのは、いくつかのテキスト構成ファイルと1つまたは2つの説明テキストを取得するのと同じくらい簡単です。 多数(50以上)のWindowsボックスの構成を文書化することに直面して、サービス構成の表示を取得することがどれほど難しいかを知り、私はがっかりしています。これらのマシンをゼロから構築しているため、すべてのマシンで構成の一貫性を保つ必要があります。Ghostなどを使用して実際にすべてのサーバーをイメージしますが、ADやExchangeなどのサービスの実際の構成は、手動でポイントアンドクリックするプロセスであるため、矛盾が生じやすくなります。 一貫性を確保するビルドドキュメントの作成について、どのように提案すればよいですか?次に、スクリーンショットなどの負荷に頼ることなく、構成をどのように文書化しますか?Camtasiaを使用して、設定プロセスのビデオを取得することを実際に検討していますが、これはばかげているようです。 ご協力いただきありがとうございます! 編集:以下の回答のいくつかは非常に有用であり、私は私がなりたい場所に何らかの方法を得ると思います。特に、スクリプト可能なインストールに応答ファイルを使用すると、一貫したインストールを作成するのに役立ち、WMIツールの一部はドキュメント(LANsweeper、SYDisprojectなど)に非常に役立ちます。 私が本当に望んでいるのは、すべての設定を人間が読める/編集可能な形式に吐き出し、それをすべて吸い戻すことができるツールを持つことです。Unixは基本的に自己文書化構成ファイルでこれを常に行っているので、おそらく最新のOSに同じ機能を持たないことは大きな失望です!

4
MediaWikiを使用したITドキュメント
ドキュメントをさらに強化し、情報への簡単なアクセスと情報の編集を可能にする機能を探しています。これらのアイデアを念頭に置いて、ティア1(ヘルプデスク)のMediaWikiプラットフォームに基づいて内部wikiを作成しました。これはヘルプデスクにとって大きな成功であり、彼らは日常業務でこれを広く使用しています。現在、Tier 2(システム管理者)のために物事を文書化する方法を検討しています。情報の機密性と、サーバーの構築方法などの手順が含まれるという事実のため、Tier 2の情報をTier 1の情報とは別にする必要があります。 次の目標を達成する方法に関連するアイデアや提案を探しています。 MediaWikiプラットフォームに基づく一元化されたドキュメント ティア1とティア2の間のコンテンツの分離 ティア1のルックアンドフィールが気に入っており、ティア2にも使用できます MediaWikiの2つの異なるインストールを実行する場合、これを同じサーバーで実行できますか?同じマシン上でMediaWikiの複数のインストールを実行するのは良い考えですか? 各ドキュメントインストールのFQDNおよびSSL証明書のサポート ユーザーまたはグループのメンバーシップに基づいて、Tier 1 MediaWikiインストールの一部をスライスまたは保持する方法はありますか? よろしくお願いします。あなたのアイデアや提案を楽しみにしています。

6
Macのシステム管理者として知っておくと便利なことはどこで文書化できますか?
私は最近、Macのディレクトリサービスツール(dscl、dsimport、dsexport)について調査しました。すべての利益のために(そしておそらく私の作業を改善できる場所に)どこかでそれらを文書化できるようにしたいと思います。良いウェブサイトが既に存在する場合、この目的のために自分のウェブサイトを掲載することには利点がありません。 テキストや画像を使って文書化できる優れたWiki(または同様のもの)はありますか(スクリーンキャストも素晴らしいでしょうが、そのための場所を期待していません)、Mac管理者として知っておくと便利なことはありますか?

6
データセンターのドキュメント用の無料ツール[終了]
閉まっている。この質問はトピック外です。現在、回答を受け付けていません。 この質問を改善したいですか? 質問を更新することがありますので、話題のサーバー障害のため。 7年前に閉鎖されました。 ラック内のサーバー、接続先のグループポートなどの情報について、データセンターでのドキュメント作成を改善するのに役立つ無料のツールはありますか?

2
RHEL 6を保護するためのNSAガイドに近いもの[終了]
閉まっている。この質問はトピック外です。現在、回答を受け付けていません。 この質問を改善したいですか? 質問を更新することがありますので、話題のサーバー障害のため。 5年前に閉鎖されました。 インフラストラクチャグループの一部は、RHEL 6の新機能を活用するためにアップグレードしたいと考えています。過去には、NSAガイド(www.nsa.gov/ia/_files/os/redhat/rhel5-guide- i731.pdf)RHEL 5およびCentOS 5インストールを保護します。このガイドは非常に貴重です。 そこにいる人は、RHEL / CentOS 6を同様の方法で保護した経験がありますか?もしそうなら、どのリソース(書面または相談)を活用しましたか? 一部の同僚から、バージョン6とバージョン5はさまざまな点で大幅に異なると聞きましたが、その違いを十分に説明していなかったため、セキュリティに大きな穴を残したくありません。 RHEL 6のRed Hat独自のガイド(http://docs.redhat.com/docs/en-US/Red_Hat_Enterprise_Linux/6/html/Security_Guide/index.html)は本当に十分ですか? 機能的な理由がない限り、NSAのようなグループが保護しようとしているバージョンに固有のガイドを作成できるようになるまで、5から6へのアップグレードを控えるべきだと言う人はいますか? より適切なフォーラムに導かれている場合でも、ご意見をお寄せください。 よろしく、 マイク

6
Linuxサーバーの構成を文書化する方法は?
構成を文書化する必要があるLinuxサーバーは約20台あります。私はないではない、すべてのサービスの詳細な構成を意味するのではなく、その他のユーザーアカウント、データベース、データベースのアカウント、IPアドレス、物理的な場所、SSHポートなどIこのすべてのデータは、設定ファイルに保存されているけど、私はそれを集中管理します。このデータを記録するためにスプレッドシートを作成することを検討していますが、ハッキングされたスプレッドシートよりも構造的で完全なもの(おそらく小さなphp / mysqlアプリ)があるかどうか疑問に思っていました。 あなたは何を使うのですか?

4
Linuxでodbc.iniおよびodbcinst.iniファイルの適切なドキュメントを探している
部分的な情報、古い情報は見ましたが、実際のサンプルファイルほど良いものはありませんでした。 との正確な関係を理解する必要がodbc.iniありodbcinst.iniます。表面的にはかなり明白です- odbc.iniファイルの先頭に次のようなセクションがあります: [ODBC Data Sources] MYDSN = MyDriverName ... ただし、たとえば、ドライバーまたはDSNセクションのいずれかで設定できるかどうかはわかりません。 1)Driver = /path/to/file/.so両方のファイルに行があり、値が異なる場合があります。これは理にかなっていますか?ある場合、どちらが優先されますか? 2)odbcinst.iniJavaScriptのような「プロトタイプ」odbc.iniですか?言い換えれば、私は一般的な設定でのDSNの数を作成していた場合、私はから、共通の設定を促進することができるodbc.iniにodbcinst.ini? 3)DriverとSetupin の違いは何odbcinst.iniですか?それらは同じ値を持っているようです。これらの設定はデータベース固有ですか、それともユニバーサルですか?

4
ネットワークインフラストラクチャラベリングの業界標準
ラックとジャックで建物の物理インフラストラクチャにラベルを付ける方法と、ドキュメントをどのようにレイアウトするかを定めた、IEEE、ISO、ANSIなどの現在の業界標準はありますか?IEEE Std 200があることは知っていますが、それは時代遅れであり、電気製品のASME標準を見つけましたが、実際には読むことができません。


弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.