As discussed in today’s Documentation Team meeting, I had some suggestions about the User Guide chapter template.
I know there was some previous discussion here:
but I thought it would be more convenient to start a new thread and link back to that discussion.
1. Make indents uniform increments
As far as possible, use increments of, for example, 7 mm when creating indents. It makes the document look a bit neater. It is also easier to work with when using bullet points in indented text.
In the above example, I also:
- Made the List 1 style line up with the left margin
- Used left-aligned numbers and tab-stops instead of spaces after the bullets/numbers to make them line up more uniformly.
- Used the outline list feature to indent the unordered list, instead of creating a separate style. I’m not sure if there is a technical reason why we don’t normally do this.
- Tweaked heading styles a little (just to see how it looked)
2. Change the indentation for the Definition name style
I think indentation is a good way to highlight menu options, but I find it easier to read if the text lines up with the heading. Maybe that’s just me.
I also changed the color to make them stand out a little more.
Thoughts? Ideas? Constructive criticism?