GitHub ガイドラインの作成方針

この記事では、GitHub ガイドラインの作成方針について記載します。

1. コンテンツの方針

具体的に、どのように記事を作成するかについての方針を定めます。

読み手が『この記事はいつ作成されたものか』『最終更新日はいつか』を把握できるように、ヘッダーに作成日と更新日を記載します。
GitHub の機能は日々進歩しており、記事の内容よりも良い機能が提供されていることもあります。
いつの情報であるかを把握できることは、読み手にとって重要です。

# 記事タイトル

*作成: 2024/04/23 | 更新: 2024/05/01*

以下の文面を記載します。

注意: この記事は、個人的な技術利用方針であり、推奨事項やベストプラクティスの主張や提示ではございません。
個人的なアプローチ例の紹介であり、すべてのプロジェクトや環境に最適とは限りませんが、参考にしていただけると幸いです。

ソフトウェア設計や製造の進め方、サービスの利用方法など、各々個人の考え方やプロジェクトメンバーによって、最適は異なります。
誤解を招かないために、最初にこの文面を記載します。

フッターとして、フィードバック提供方法や連絡先を記載します。
直接的に連絡先を記載すると、連絡先が変更があった場合に全ての記事を修正する必要があるため、基本的にプロフィールページへの誘導リンクを記載します。

ディスカッションから新たな知識や見解が生まれることもあります。
読み手からの意見を受け入れる姿勢を示すために、フィードバック提供方法や連絡先を記載します。

ateliers-knowledge リポジトリでは、以下のように運用します。