開発者ドキュメント

DigitalOceanが提出した記事のルーブリック

序章

DigitalOceanは、Linuxサーバーユーザーに役立つさまざまなオープンソーストピックをカバーするために、美しく書かれたチュートリアルのライブラリを構築することに興奮しています。

DigitalOcean「GetPaidto Write Initiative 」で専門知識のトピックについて書くように著者を招待し、公開前に送信された各記事を個別に確認します。 各著者に記事に関する個別のフィードバックを提供したいと思いますが、残念ながら、時間の制約により、常に可能であるとは限りません。

代わりに、記事を成功させるためのさまざまな基準を説明するルーブリックを作成しました。 DigitalOceanコミュニティで公開されているすべての記事が、すべてのカテゴリで4または5に値することを目指しています。

私。 文法

  1. この記事には重大な文法またはスペルの問題があり、基本的または誤った文の構造が特徴です。 著者は、特定のフレーズを複数回繰り返す場合があります。
  2. この記事には、文法やスペルの問題がいくつかあります。 基本的または単純な文体で書かれています。 執筆にはいくつかの文体の問題があります。
  3. この記事には、文法やスペルの問題がほとんどありません。 著者は彼らの考えを明確に伝えることができます。
  4. この記事には文法上の問題はありません。
  5. 記事の文法は申し分のないものです。 著者は独特で魅力的な文体を持っています。

II。 単語の選択

  1. この記事の語彙は非常に少ないです。 言葉は基本的なものであり、説明的なものではありません。 記事を読む経験は苦しんでいます。
  2. 記事の語彙は限られています。 記事はよく読めません。
  3. 記事には適切な語彙があります。
  4. この記事には、多様で興味深い単語の選択肢があります。 記事は語彙によって強化されています。
  5. この記事には非の打ちどころのない言葉の選択肢があります。

III。 構造

  1. この記事には構造も休憩もなく、アイデアの明確な論理的配置もありません。 この記事では、必要な手順をスキップし、読者の多くを想定しています。
  2. この記事は、誤って適用された構造になっています。 この記事では、1つのステップであまりにも多くのコマンドと変更をグループ化した可能性もあります。
  3. この記事には明確な操作の順序があります。 記事のセクションが長すぎたり短すぎたりする場合があります。 記事の説明が多すぎたり少なすぎたりする場合があります。
  4. 記事は、明確で読みやすいように健全な構造になっています。
  5. 記事は、実際に記事を完成させやすくする非の打ちどころのない構造を持っています。

IV。 長さ

  1. 記事が短すぎます。 この記事は、各ステップについて多くの説明を提供しておらず、議論している主題をかすめるだけです。
  2. 記事は短い側にあります。 記事の内容が狭すぎるか、説明が非常に不足しています。
  3. 記事の長さは適切です。 この記事は、適切に提示されたトピックをカバーしていますが、例外的な深さはありません。
  4. 記事の長さは十分です。 この記事では、そのトピックについて詳しく説明し、役立つ場合は追加の説明を提供します。
  5. 記事の長さは非常に長いです。 説明は豊富で詳細です。

V。 出版の準備

  1. この記事には多くのタイプミスがあり、校正されたようには見えません。 すべてのエラーのため、記事をフォローするのは困難です。
  2. この記事には多くのタイプミスと書き込みの問題があります。 問題を修正し、出版のために記事を準備するには、編集者の側でかなりの量の作業が必要になります。
  3. この記事にはタイプミスがほとんどなく、明らかに偶発的なものです。 フォーマットに問題がある可能性があります。
  4. この記事にはタイプミスはなく、フォーマットに関する非常に小さな問題があります。
  5. 記事は公開の準備ができています。タイプミスがなく、完全なフォーマットになっています。

VI。 技術的精度

  1. この記事は、安全でない誤った慣行を提唱しています。 推奨の理由は洗練されていません。 例:権限の問題を解決するためにchmod777を推奨します。
  2. この記事は、安全でない慣行を提唱しています。 この記事の推奨事項はベストプラクティスではありません。
  3. この記事は、合理的に安全な慣行を提唱していますが、それが何をするのかを推奨する理由を深く掘り下げていないため、読者は盲目的に推奨に従うことができます。
  4. この記事は、優れた実践を提唱し、それらがなぜ役立つのかを読者が理解しやすくします。
  5. この記事はベストプラクティスを提唱しており、著者が特定の手順を推奨した理由を読者が理解するのに役立ちます。

VII。 チェック完了のしやすさ

  1. 記事を完成させることはできません。コマンドのタイプミス、スキップされたコマンド、読者の知識についての仮定などに問題があります。 問題は非常に深いため、編集者は簡単に修正できません。
  2. 記事を完成させることはできません。コマンドのタイプミスに問題があります。 コマンドは過失からスキップされます。 問題は編集者が修正できますが、非常に多くあります。
  3. この記事には最小限の問題があり、レビュー中に完了することができます。 作成者が依存関係を見逃した場所が1つか2つあるかもしれません。 全体的に記事は良いです。
  4. 記事は技術的な問題なしに簡単に完成させることができます。 さらに説明が必要な箇所があるかもしれません。
  5. 記事は簡単に完成でき、公開の準備ができています。
モバイルバージョンを終了