Stack Overflowで答えを見つけてバグを解決することがよくあります。なぜ自分がしたことのスニペットを追加してから、Webから記事またはページへのリンクを追加することは悪い習慣ですか?
Stack Overflowで答えを見つけてバグを解決することがよくあります。なぜ自分がしたことのスニペットを追加してから、Webから記事またはページへのリンクを追加することは悪い習慣ですか?
回答:
これが、企業が独自のナレッジリポジトリを持つ必要がある理由です。たとえば、私の会社には、プロジェクトの管理、発券(バグとタスクの追跡)、および私が最も使用するツールであるwikiに使用される企業Redmineがあります。プロジェクトごとのこれらすべての機能:-)
プロジェクトのwikiには何がありますか?
私は入れ目録で(リンク)その他のウィキ。しかし、私が信頼する人からのみ:
私の参考文献には、自分がリンクしているものを確実に理解できるようにするために、私が入力した要約が付いています。私はJavadocをできるだけ明確に保つようにしています。コード内のすべてのリンクは、RedmineのwikiまたはRedmineの課題コードを参照しています。
Redmineのようなツールがない場合、私はこれらの目的に役立つ有用なMarkdownファイルを見つけました。これらのファイルに起因する開発者にとって全体的にはSCMにあり、コードに付属しています。
インターネットへのリンクは、ドキュメントとしてはやや問題があります。インターネットは、その背後にあるコンテンツが将来のドキュメントリーダーに表示されるコンテンツと同じであることを保証しないためです。可能であれば、変更される可能性が非常に低いリソースにのみリンクするようにしてください。
たとえば、Wikipediaにリンクする場合は、一般的な記事名ではなく、今日のバージョンに明示的にリンクする必要があります。stackexchange.comの場合、現時点ではなくなる可能性は低いようですが、質問は常に編集されたり、削除されたりします。5年後には、新しい新しい収集ポイントが登場する可能性があります。私は、組織の外部にあるサイトで、実質的なビジネス価値をもたらすドキュメントをぶら下げる危険を冒しません。