コミュニティ iKoula の記事を書く方法
zh:如何写一篇文章为社区 iKoula
fr:Comment rédiger un article pour la communauté iKoula
这篇文章是从由软件进行自动翻译。你可以看到这篇文章的源代码
ikoula その技術的な知識ベースを拡大したいです。これらのブログの目的がよく書かれた、わかりやすいチュートリアルを提供するために、ホストによって提供されるサービスに関連するさまざまなトピックに。文章のスタイルの特定の結束を持つために以下の推奨事項を説明しました。
哲学
ナレッジ ベースの記事は、心で読取装置と書かれています ! つまり、記事の著者がすべきこと :
- リーダーの技術水準に関する仮定をしないこと。
- 可能な限り明確に明示的に各ステップを説明します。
- そのチュートリアルは、彼らが動作確認するための新鮮なインストールできればテスト "スクラッチ ".
- 誰もが理解できるように記事を書きます。
構造
記事は、詳細な手順と可能な限り明確にするために書かれています。読者が記事を正確に従うことを確認して拡大鏡ないワンステップの記事 ikoula 指示と説明を交互に書き込まれなければなりません。つまり、各段階でコマンドの説明する必要があります。 または操作とそれを表示する必要があります。
それは情報の数をブロードキャストするときオンライン注文を組み合わせたり、単に説明もなしにそれらをリストする魅力的な場合があります。しかし、これは読者の理解のため、推奨される方法ではありません。
それは単にコピーする魅力的なプレイヤーはアイテムをスキャンするとき /それは訓練するのに理解せずに、表示された情報を貼り付けます。特に場合は、主題は彼に精通しています。これは、なぜの知識ベースの記事 ikoula 教育、教育、提示された情報を理解する読者を許可する各のための説明を提供すること目的としています。
これらの説明は、多くの情報を渡す場合に特に理解で重要な役割を果たします。構成ファイルまたは長いインストールなど、多くの変更がある場合は、その詳細、可能な限り行う必要がありますそれぞれの変更お勧めします。
2 つのことを避ける必要があります :
- 長い構成ファイルには、説明もなくコピーが紹介されました。
- ダウンロードし、インストールを加速または、プロセスを構成する詳細については明示的にしない限り、実行するスクリプトします。
さらに、記事では、複雑なインストールについて説明します、複数のサーバーを参照するときに特にお勧めしますチュートリアルの目的を説明したセクションを含める。
図を使用する場合誰もが理解するために、凡例を含めることを忘れないでください。
コメントの自動更新を有効化