Skip to content

Latest commit

 

History

History
78 lines (75 loc) · 3.13 KB

.copy-edit-stylesheet-checklist-ja.md

File metadata and controls

78 lines (75 loc) · 3.13 KB
Raw

BOLTs のコピー編集に使用する基本的なチェックリスト／スタイルシート

貢献は、このチェックリスト／スタイルシートに従って、正確で明確、一貫性があり簡潔な BOLTs を維持する必要があります。

  • スペル
    • tools/spellcheck.sh --check [0-9][0-9]-*.md を実行
      • .aspell.en.pws に不足している単語を追加
    • タイポ
  • 文の構造
    • 文の断片
    • 走り書きの文
    • ぶら下がり、誤った修飾語
    • 一貫した段落の時制 (例：過去、現在、未来)
    • 受動態 (例：「私たち」を避ける)
      • 「us/them」や「we/they」ではなく「local/remote」の用語を使用
      • 例外：Introduction セクション
  • 大文字
    • 目次
    • 見出し
    • 完全な文を含むリスト項目の大文字化
    • よく忘れられるもの：「Lightning」、「ID」
    • ネットワークと通貨単位の区別
      • 例：「The Bitcoin network transfers bitcoins.」
  • 句読点
    • 正しいコンマ、コロン、セミコロン、エムダッシュの配置
    • 結合された項目には、接続詞の前にコンマを使用
      • 例：「this, that, and the other」
    • 適切な括弧の使用
    • リスト項目に完全な文が含まれる場合のみピリオドを使用
      • 例外：Requirements リスト
  • 略語
    • 例：e.g., i.e., etc., a.k.a.
  • フォーマット
    • 文間のスペースは一つ
    • 強調、強調、コード、CAPS、'引用' の一貫した使用
    • 段落とページ要素の間に一行の区切り
    • 正しい見出しの重みを確認
  • 数字と計算
    • 小さな数 (<10) は綴る
    • 数字と列挙のタイプ
      • 例：「two 2-byte blocks set to 0s」、「one 4-byte block set to 1s」、「the other one is equal to 1」
      • 例外：例「non-zero」、「1 byte in length」
    • データ測定
      • 情報の量には数字を使用し、単位が形容詞の場合はハイフンを使用
        • 例：「a 32-bit block is 32 bits in length」
    • タイプされた計算の場合
      • 演算子の両側にスペースを入れる (ただし '^' と負の数は除く)
        • 例：5 - 3^2 * 4 = -31
    • 計算の説明の場合
      • 演算子を綴る
        • 例：1 less than 3 equals 2
  • リスト構造
    • 項目の前に 2 スペース
    • 2 スペースのインデント
    • Requirements セクション
      • 条件の後にコロン
      • サブ項目の前にコンマ
      • 分岐の終わりにピリオド
      • 例：
      A sending node:
      - MAY do this.
      - if this, AND this:
        - SHOULD do this.
      - otherwise:
        - MUST do this,
          - but MUST NOT...in this case.
  • リンク
    • 壊れたリンク
    • リンクテキスト
    • 正しいアンカー／URL
  • 参照
    • フォーマット例：1
  • タグ
    • 一貫した使用例：[TODO:]、[FIXME:]

It seems like you haven't provided the Markdown content yet. Please paste the text you would like translated, and I'll assist you with the translation according to the rules you've specified.