ドキュメントに外部リンクを追加することは悪い習慣ですか?


9

Stack Overflowで答えを見つけてバグを解決することがよくあります。なぜ自分がしたことのスニペットを追加してから、Webから記事またはページへのリンクを追加することは悪い習慣ですか?



FWIW私はいつもそれをやっていて、StackExchangeでこれを適切に行う方法さえ尋ねました。それはあなたの質問に答えるものではありませんが、賛否両論がそこにあります。


あなたはコード/回答の一部をコピーすることについても言及しているので、質問はリンクについてのみです(私にとってはOKです)。これは、複雑なアルゴリズムや処理を説明するためだけに行うことです。コードの構造と命名は、ソリューションについてどこから読むかとは関係なく明確でなければなりません。
Kwebble 2017年

回答:


14

私はそれは悪いとは思いませんが、外部リンクはソリューションのライフサイクルを離れるという悪い癖があります。その際、リンクが機能しなくなった場合に読者を助けるのに十分な要約を入れることをお勧めします。


3
2つの理由で役立つ要約の追加:1)ジムが指摘したように、リンクが古いかどうかを読者が理解するのに役立ちます。2)開発者がリンクからコードをコピーして、何がコピーされているかを理解するように強制します。これは、「問題を解決する」ためにコードが使用されていないことを確認するのに役立ちます。
Mage Xy

7

これが、企業が独自のナレッジリポジトリを持つ必要がある理由です。たとえば、私の会社には、プロジェクトの管理、発券(バグとタスクの追跡)、および私が最も使用するツールであるwikiに使用される企業Redmineがあります。プロジェクトごとのこれらすべての機能:-)

プロジェクトのwikiには何がありますか?

  • ドキュメントへのリンク:機能、技術、アーキテクチャ、要件。
  • 関係者:プロジェクトマネージャー、開発者、お客様の主要アカ​​ウントマネージャー、...
  • 環境ごとの説明:仮想マシン、OS、サーバー、構成...
  • その他:プロジェクトの存続期間中に学んだ(プロジェクトに関連する)重要な/興味深いこと。
  • さらにいくつかのページ。

私は入れ目録で(リンク)その他のウィキ。しかし、私が信頼する人からのみ:

  • スタックオーバーフロー:肯定的な投票と十分な議論
  • ソフトウェアエンジニアリングStackexchange:賛成票とよく議論
  • MKyong.com:このページが好きです。とても便利で、そのチュートリアルはとても簡単です
  • MDN
  • W3C.org
  • W3Schools:そのドキュメントはインタラクティブ(ほとんどの場合)でユーザーフレンドリーです。
  • OWASP:セキュリティと脆弱性に関連する問題の参照用
  • 公式ウェブページ:時々、最高のチュートリアルや説明が公式ウェブページにあります。

私の参考文献には、自分がリンクしているものを確実に理解できるようにするために、私が入力した要約が付いています。私はJavadocをできるだけ明確に保つようにしています。コード内のすべてのリンクは、RedmineのwikiまたはRedmineの課題コードを参照しています。

Redmineのようなツールがない場合、私はこれらの目的に役立つ有用なMarkdownファイルを見つけました。これらのファイルに起因する開発者にとって全体的にはSCMにあり、コードに付属しています。


1
私はW3Schools.comを信頼する以外はすべてに同意します。MDNには、より多くの権限を持つほとんどのものが見つかります。
Alternatex

1
W3schoolsはMDNよりもずっと前から存在しています。私は間違っているかもしれませんが、W3schoolsにはより多くのコンテンツ、チュートリアル、およびWebテクノロジーのドキュメントがあると思います。その問題にもかかわらず、そのコンテンツははるかにユーザーフレンドリーでインタラクティブであるため、初心者にとって最高のリファレンスの1つであり続けています。プラス面として、MDNにはそのコンテンツをサポートする素晴らしいコミュニティがあります。しかし、マイナス面としては、防御するブラウザーがあるため、ドキュメントが公平であるとは言えません。とにかく、私はあなたに同意します、今MDNはより多くの権限を持っているようです。よろしければ、回答に参照を追加します。
ライヴ

4

インターネットへのリンクは、ドキュメントとしてはやや問題があります。インターネットは、その背後にあるコンテンツが将来のドキュメントリーダーに表示されるコンテンツと同じであることを保証しないためです。可能であれば、変更される可能性が非常に低いリソースにのみリンクするようにしてください。

たとえば、Wikipediaにリンクする場合は、一般的な記事名ではなく、今日のバージョンに明示的にリンクする必要があります。stackexchange.comの場合、現時点ではなくなる可能性は低いようですが、質問は常に編集されたり、削除されたりします。5年後には、新しい新しい収集ポイントが登場する可能性があります。私は、組織の外部にあるサイトで、実質的なビジネス価値をもたらすドキュメントをぶら下げる危険を冒しません。


「ウェイバックマシン-インターネットアーカイブ」(web.archive.org/)は、削除されたコンテンツをチェックするのに適した場所です。
Kromster
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.