ドキュメントベストプラクティス

このページは QMK のためのドキュメントを作成する時のベストプラクティスを文章化するためのものです。これらのガイドラインに従うことで、一貫したトーンとスタイルを維持することでき、他の人が QMK をより理解しやすくすることができます。

ページの開始

ドキュメントページは通常 H1 ヘッダで始まり、最初の段落を使ってこのページの内容を説明します。この見出しと段落は目次の次にあるため、見出しは短くして空白の無い長い文字列を避けるように気を付けてください。

例:

# My Page Title

This page covers my super cool feature. You can use this feature to make coffee, squeeze fresh oj, and have an egg mcmuffin and hashbrowns delivered from your local macca's by drone.

見出し

通常、ページには複数の "H1" 見出しが有るべきです。H1 と H2 見出しのみが目次に含まれるので、適切に計画してください。目次が広くなりすぎないように、H1 と H2 の見出しでは幅を広げないようにしてください。

スタイル付きのヒントブロック

注意を引くためにテキストの周りにスタイル付きのヒントブロックを描くことができます。

重要なもの

!> This is important

以下のように表示されます:

!> This is important

一般的なヒント

?> This is a helpful tip.

以下のように表示されます:

?> This is a helpful tip.

機能を文章化する

QMK のために新しい機能を作成した場合、そのドキュメントページを作成してください。長い必要は無く、機能を説明する幾つかの文と、関連するキーコードを列挙した表で十分です。以下は基本的なテンプレートです:

# My Cool Feature

This page describes my cool feature. You can use my cool feature to make coffee and order cream and sugar to be delivered via drone.

## My Cool Feature Keycodes

|Long Name|Short Name|Description|
|---------|----------|-----------|
|KC_COFFEE||Make Coffee|
|KC_CREAM||Order Cream|
|KC_SUGAR||Order Sugar|

ドキュメントを docs/feature_<my_cool_feature>.md に配置し、そのファイルを docs/_summary.md の適切な場所に追加します。キーコードを追加した場合は、機能ページに戻るリンクとともに docs/keycodes.md に追加するようにしてください。

2.7 KiB Raw Blame History