WSOFTDocs 共同作成ガイドの概要
この記事では、WSOFTDocsにある製品についての情報や記事への改善案をフィートバックする方法を説明します。
WSOFTDocs 共同作成ガイドへようこそ。
WSOFTのドキュメントは、すべてオープンソースでGitHub上でホストされていて、そこでPullRequest(PR)を使って記事の追加や更新を提案できます。この仕組みにより、私たちと読者のみなさんとの間とでよりよいドキュメントを作れます。
WSOFTDocsの改善にご協力いただき、ありがとうございます。
コントリビューター行動規範
WSOFTのオープンソースプロジェクトでは、コントリビューター行動規範にしたがって行動することが求められます。詳しくはコントリビュータ行動規範を参照してください。
重要
WSOFTDocsでは、使用条件およびMITライセンスが採用されています。ご意見や質問がある場合は、info@wsoft.ws までご連絡ください。
変更不可能なコンテンツ
法的資料など一部のコンテンツは、たとえ変更内容が誤植の修正など軽微なものであったとしても、変更は許可されません。これらの記事の変更を含むpull requestは拒否されます。
ドキュメントを編集する
さまざまな努力を重ねても、公開されたドキュメントには誤植や文法に関する小さな誤りが"必ず"入り込みます。これを受け入れることも大切なことなのですが、これを極力減らしていくことも大切なことです。Issueを作成して間違いを報告することもできますが、利用可能な場合は、PRを作成して問題を修正するオプションの方が早くて簡単です。
ドキュメントを編集する方法について知るには、ドキュメントの編集を参照してください。
オープン中のpull requestをレビューする
pull requestsタブを確認することで、新しい記事やその変更を公開前に確認できます。それらをレビューしてコメントを追加することで、コミュニティにフィードバックできます。
記事に関するIssueを作成する
WSOFTDocsは、現在進行形で開発が継続されているプロジェクトです。 適切なIssueの投稿は、WSOFT Docsを改善するために役立ちます。 提供していただく情報が詳細かつ具体的なほど、Issueは役立つものとなります。お探しだった情報を教えてください。ご使用になった検索語句をおしえてください。ガイドやドキュメントがわかりづらかった場合、どのようにするのが望ましいかお教えください。
編集時に役立つ記事
記事の執筆や編集前に、Markdownの書き方や、WSOFTDocsの記事執筆ガイドなどをぜひご覧ください。
LantanaやMkDocsの開発に参加する
WSOFTDocsのユーザーエクスペリエンスの大部分は、Lantanaによって提供されています。Webページのユーザーエクスペリエンスについてご意見がある場合は、Lantanaのリポジトリへお願いします。 また、ドキュメントの生成システムは、MkDocsによって提供されています。MkDocsについても、MkDocsのリポジトリへお願いします。