Pecan: ドキュメントの概要

@robkooperと@ashiklomは、アウトラインの2つのアイデアを組み合わせようとしました。 @KristinaRiemerと@bailsofhayは、フィードバックを得るのに適しています。 すぐに実装を開始して、月末までにページを目的の場所に移動できるようにします。

これは本当に良さそうだと思います。 これは、既存の資料を再配置するだけで、何も追加しませんか？

これを行うとき、第41章は実際には40より前に進む必要があります。

@KristinaRiemerええ私は物事を動かすつもりです。 その間に、不足しているものを特定して問題を起こすことができます。 これは「エピック」問題としてラベル付けされているため、これらの他の問題をこの問題の下にリンクして、整理された状態を維持できることに注意してください。

私はちょうど私がしていることについての簡単な記事で使用するためにいくつかの用語のドキュメントを見回していました。 なぜ誰かがピーカンナッツを使いたがるのかについての最良の説明がドキュメントにないことに気づきました（具体的には、不確実性分析の説明が欠けています）。 これは、現在利用可能なドキュメントの「プロジェクトの概要」セクションに配置するのが理にかなっていますが、作業中の再編成されたドキュメントのどこにこれを追加するかはわかりません。

ドキュメントに関する@infotrophからのリンク： https ： //www.divio.com/blog/documentation/

ドキュメントに関する@infotrophからのリンク： https ： //www.divio.com/blog/documentation/

より多くのコンテキスト：この部分は、4つの異なるタイプのソフトウェアドキュメントがあり、すべての十分にドキュメント化されたプロジェクトは、明示的に別個のセクションとして4つすべてを持つ必要があるという強く主張されたケースを作成します。

• チュートリアル、初心者にツールが何をするかを、毎回説明されているとおりに正確に機能することが保証されているステップバイステップの例を使用して教えるため
• how-tos 、ユーザーが「How do I ....？」という形式の質問に答えるために行くことができるクックブックセクション。特定の質問に必要な詳細のみが含まれています。
• モノを呼び出す方法、それらが話すプロトコル、およびそれらが返す値の詳細については、リファレンスを参照してください。
• ディスカッションでは、物事がそのように機能する理由を説明し、背景情報を提供し、良い慣行と悪い慣行についてアドバイスし、そうでなければ他のセクションに適合しないコンテキストを提供します。

この問題は365日間開いており、アクティビティがないため、古くなっています。

長期的には、チュートリアル/ハウツー/リファレンスの概念はしっかりしていて、それをより均一に適用することでドキュメントを明確にすることができると思います。 しかし、ここで最初に説明したreorgは十分に実装されているので、この問題を閉じて、さらにクリーンアップするために新しいスレッドを奨励します。