Sphinxの手順書スタイル

• Sphinxのドキュメントスタイル をベースにする。

• 参考文献や確認環境があれば記述する。

• 参考文献

  • URL

• 確認環境

  • Windows 10

  • Python 3.9

注釈

工程が複数のサブセクションに分かれていなければ、サブセクションを使わず、 .. ruburic:: 手順 を使う。 目次も不要。

背景・方針

• 必要に応じて、背景や方針、作業の流れを書く

• 冒頭の箇条書き概要で十分であれば、省略する

前提条件

• 必要に応じて、前提条件や事前準備について記述する

事前準備

• 必要に応じて、事前準備について記述する

手順

• ステップ毎に改行する

• 簡潔に書く

• 何かについて具体的に説明したり、横道にそれるような記述はしない

• 補足や具体的な説明は、専用のセクションを設けたり、ページを分けてリンクする

動作確認

• 必要に応じて、手順通りにできているか確認する方法を記述する