# BTCPay Server のドキュメント作成

# ドキュメントが重要な理由

ドキュメントは、あらゆるスキルレベルのユーザーに対して、ソフトウェアとその使い方に関する簡潔で明確な情報を提供するために不可欠です。BTCPay Server には多様なユースケースがあり、その結果、ドキュメントから情報を求めるユーザーの種類も多岐にわたります。BTCPay Server に貢献する執筆者は、他のどの貢献者と同じくらい重要です。

特定分野の技術知識がある方、新機能のドキュメント化を手伝いたい方、あるいは BTCPay Server プロジェクトに関わりたい方にとって、ドキュメント作成は貢献を始めるのに最適な場所です。

執筆スキルがある、または英語にある程度の知識がある場合、BTCPay Server に貢献したり他の貢献者の作業をレビューしたりできます。執筆による貢献には、さまざまな形があります。

# BTCPay ドキュメント

対応が必要なドキュメント作業は、Github の open issues page (opens new window) で確認できます。ドキュメント作業の開始方法は、documentation guide を参照してください。

ドキュメントのガイダンスや新しいドキュメント案の議論は、Mattermost の #documentation channel (opens new window) に参加してください。

# BTCPay ブログ

もう一つの優れた貢献方法は、BTCPay blog 向けにコンテンツを書くことです。ブログトピックを始めるには、Mattermost の #content creation channel (opens new window) に参加してください。

# 要件

執筆者として BTCPay Server に貢献するには、いくつかの要件があります。

BTCPay Server のドキュメントの多くは Github 上で提出・レビューされるため、Github account (opens new window) が必要です。また Github では、他の人が行ったドキュメント作業(pull requests)のレビューでも貢献できます。

重要事項: このドキュメントで説明している貢献は English で行うことを前提としています。その他の言語で貢献したい場合は、Translations を参照してください。

# 推奨ソフトウェア

# テキストエディター

リッチテキストエディターを用意することを推奨します。

Notepad++ (opens new window) は、使いやすく新規貢献者にも扱いやすいソフトウェアです。

より上級のユーザーには、Visual Studio Code (VS Code) (opens new window) がよい選択肢です。 VS Code の Markdown All In One 拡張機能も、編集時の視認性向上と Markdown 変更のプレビュー機能のために推奨されます。BTCPay のドキュメントは主に Markdown で書かれているため、特に有用です。

これらはあくまで推奨です。すでに使い慣れた同種のソフトウェアがあれば、引き続きそれを使用できます。

# バージョン管理

貢献作業(リポジトリの fork、ブランチ作成と作業、pull request や issue の作成など)を管理するために、Github Desktop (opens new window) の利用を推奨します。Github Desktop を使った pull request 作成の手順ガイドはこちらです。