Questions tagged [manuals]
6 questions
21
votes
4 answers
Writing a company-wide developer's handbook
I work for a small company. The software development arm of the company before I was hired consisted of one self-taught overworked guy. Now that I've been writing software for the company for a few years, I have been tasked with establishing formal…
Phil
- 3,680
- 28
- 30
10
votes
6 answers
Manuals - How Up To Date?
If you have a product that has been in the market for a long time, but it is still in active development daily - how often should the manuals be updated? If your users are constantly updated to the bleeding edge version due to the fact that your…
user4459
3
votes
2 answers
Software Manual - Where to start
Are there any software packages out there for generating a nice looking users manual for small projects? I'm not talking about source documentation. I want to create an end users manual that doesn't look like I spent 20 mins in Microsoft Word.
hfitzwater
- 171
2
votes
4 answers
Good way to document your software (product)?
Different from Fastest way to document software architecture and design. I'd like to write a manual for my software which includes
Command line usage
Howtos/Tutorials on using the software
Example code for writing plugins
Manual on functions and…
user2528
1
vote
1 answer
PDF help in the software manual
Just need a bit of advice here, if we embed Adobe Reader as an activex control, as well as have a fallback PDF viewer (in case the user doesn't have Adobe Reader installed) would it be wiser to put screenshots in the manual using whatever the…
Peter Turner
- 6,955
-2
votes
1 answer
How to produce different versions of a software manual from the same MS Word document?
I am trying to create different versions of a software manual from a single source which is in MS Word format. Is it possible to do this algorithmically or must it be done manually for every version?
Specifically, our software has three different…
Jennifer96
- 21