openstack-doc-core team mailing list archive
-
openstack-doc-core team
-
Mailing list archive
-
Message #00019
Convention for documenting a sequence of events
Hi doc'ers:
Many of the documented tasks require a sequence of steps, i.e.
First, do this… Next, do that… Afterwards, do blah, etc….
Can we come up with a convention for how to document this? Personally, I like explicitly numbering the steps rather than using "first", "second" in prose form.
1. Do this
2. Do that
3. Do the other thing
I don't have a specific proposal about the Docbook markup tags to use. if I was doing it in Markdown, I would do something like:
### 1. Foo
You do "foo" by typing the following command
### 2. Bar
You do "bar" by typing the following command
Take care,
Lorin
--
Lorin Hochstein
Lead Architect - Cloud Services
Nimbis Services, Inc.
www.nimbisservices.com
Follow ups