WSOFTDocs 共同作成ガイドの概要

この記事では、WSOFTDocsにある製品についての情報や記事への改善案をフィードバックする方法を説明します。

---

---

WSOFTDocs　共同作成ガイドへようこそ。

WSOFTのドキュメントはGitHub上で管理されているため、プルリクエストを使って記事の寄稿や更新の提案をお寄せいただけます。この仕組みによって、私たちWSOFTのメンバーと読者の皆さんとの間で協力してより良いドキュメントに改善できます。

WSOFTDocsの改善にご協力いただき、ありがとうございます。

ドキュメントを編集する

どれだけ努力を重ねても、公開されているドキュメントには必ず誤植や表現上の細かいミスが含まれてしまいます。そのようなミスに気づかれた場合は、リポジトリでIssueを作成して報告していただくこともできますが、可能であれば直接編集してPull Requestを作成することで、より迅速かつ簡単に修正できます。

ドキュメントを編集する方法について知るには、ドキュメントの編集を参照してください。

オープン中のPull Requestをレビューする

pull requestsタブを確認することで、新しい記事やその変更を公開前に確認できます。それらをレビューしてコメントを追加することで、コミュニティにフィードバックできます。

記事に関するIssueを作成する

WSOFTDocsは、現在進行形で開発が継続されているプロジェクトです。 適切なIssueの投稿は、WSOFT Docsを改善するために役立ちます。 提供していただく情報が詳細かつ具体的なほど、Issueは役立つものとなります。お探しだった情報や、ご使用になった検索語句、ガイドやドキュメントがわかりづらかった場合、どのようにするのが望ましいかお教えください。

編集時に役立つ記事

記事の執筆や編集前に、Markdownの書き方や、WSOFTDocsの記事執筆ガイドなどをぜひご覧ください。

• VS Codeで記事を投稿する
• Markdownリファレンス
• メタデータ
• テキストの書式設定に関する指針
• リンクの使い方
• コードの埋め込み方
• コントリビューター行動規範

LantanaやMkDocsの開発に参加する

WSOFTDocsのユーザーエクスペリエンスの大部分は、Lantanaによって提供されています。Webページのユーザーエクスペリエンスについてご意見がある場合は、Lantanaのリポジトリへお願いします。 また、ドキュメントの生成システムは、MkDocsによって提供されています。MkDocsについても、MkDocsのリポジトリへお願いします。