スタイルガイド

  • Markdown書式で記述します。詳しくはこちらを参照ください。
  • 「です・ます」調で統一します
  • 日本語と英語の間には見やすくするように空白を入れます。
    • 誤: メニューからSymfonyを選択します。
    • 正: メニューから Symfony を選択します。
  • ソースコードの一部やURL、コマンド、ファイル名、ディレクトリ名を文章内に記述する時はコード(`…`)を使って分かりやすく強調表示します。
    • 例: app/Resources/views/default/index.html.twig ファイルを開いて下さい。

基本的には上記のガイドに従いますが、分かりやすさを優先した例外はOKです。筆者の判断に任せます。

また、現時点では、ドキュメントを作成することが最優先です。スタイルが気になって進まないようでしたら、あまりスタイルを気にせず、ドキュメントを記述する方を優先してください。1ページ分のドキュメントが執筆できたら、最後にちょっと、スタイルをチェックしていただけると、ありがたいです。