TECH NOTES プログラミング
【サンプル】IT記事の書き方
Tech Notes の記事の書き方の見本です。コードの載せ方や手順の書き方を確認したら、このファイルは削除してください。
この記事の結論
IT記事は「結論 → 前提 → 手順 → つまずきやすい点」の順に書くと、検索から来た人が迷いません。
これは見本の記事です。確認したら、このファイル(src/content/tech/sample-tech.md)は削除してください。
この記事でできること
最初に「何ができるようになるか」「誰向けか」「動作を確認した環境」を書きます。
- 対象:Excelの定型作業を減らしたい人
- 環境:Windows 11 / .NET 8
コードの載せ方
コードは ``` で囲み、最初に言語名を書くと色が付きます。
var files = Directory.GetFiles("data", "*.xlsx");
foreach (var f in files)
{
Console.WriteLine(Path.GetFileName(f));
}
文中の短いコードは Directory.GetFiles のように ` で囲みます。
手順は番号付きで
- 〇〇をインストールする
- 設定ファイルを開く
- 次のコマンドを実行する
つまずきやすい点
読者がエラーで困りそうな点を先回りして書くと、信頼される記事になります。