For example, let me start at the beginning. There doesn't seem to be any consistency with even the name of what I am writing. What should I call this?
- User Manual
User's Manual
User Guide
User's Guide
- 1.) You click the Start button to start the server. (and is it "Start button" or "Start Button"?)
2.) Click the Start button to start the server.
3.) To start the server, click the Start button.
4.) Clicking on the Start button starts the server.
I also have a question about the organization. For example, I have a main window with several buttons. Which organization should I use?
1)
Overview
How to do stuff
-- How to start the server
-- How to stop the server
-- How to launch and connect the client
Reference
-- The Main window
----The Start button
----The Stop button
----The Connect button
----The Host IP edit box
Troubleshooting
2)
Overview
Reference
-- The Main window
----The Start button
----The Stop button
----The Connect button
----The Host IP edit box
How to do stuff
-- How to start the server
-- How to stop the server
-- How to launch and connect the client
Troubleshooting
And should I repeat myself or link?
For example, when describing "How to start the server" I will mention the Start button. When I then get to the reference section and get to the Start button, should I repeat my information or should I like to the "How to start the server" topic?
In a perfect world I would be able to download a free PDF with answers to questions like this. Is it a perfect world?
Thank you for spending your valuable time to help get a noob started.
Chaim Krause