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