![]() ![]() The manual will be searchable/discoverable for anyone searching the forum without any need of copying “the real” manual over and essentially keeping two versions up-to-date.Users will be the same user accounts as the forum users, making permission management very easy (not only for existing staff users but it will also be very easy to give permission to other forum users who are willing to contribute and they will not have to learn another system/create another account).(In that case, please send me the non-pdf version of the text)Ĭlean, nice, customizable design with easy navigation for end user through the sections. I guess I don’t need to explain the huge advantages this way of working would have for keeping the manual I can hear you thinking: why are you telling me that now that I have written the bloody thing in a text editor? (At least that is what I would think.) So if you want to transfer the manual to a topic, I’m offering my assistance in moving everything over. ![]() When you are reading the manual topic you will still see links under each post, indicating if there has been any discussion on that part of the manual.the manual topic may be much more accessible because you only see the manual (and are not distracted by comments and questions).they can still quote any part of the manual with ease.But, as I think of it, maybe that is not such a big problem after all because: The downside would be that the entire manual would have to be in a single topic (though it could still consist of many posts) and that topic would then obviously restricted for posting by staff only so that users would not be able to comment by replying directly on a specific post. So another way of going about this would be to actually use the forum as your editor when writing the manual. If there’s much to discuss, I could open a new topic for manual corrections.īTW, if you’re not aware: you can easily print any forum topic as a pdf. I can fix small problems (typos, adding/changing/removing some words) and report “big” issues (add a subject/chapter, reorder content) that are elegible for discussion back to the forum. I prefer receiving issues by PM in an attempt to keep this topic clean. Spelling or grammar mistakes? Please submit!.Can something be improved to the layout or content?.Is there any information that should be covered by the manual that is missing in the latest version?.FAQ’s, Troubleshooting and Howto’s are covered nicely by the forum.īefore marking it as final, can anyone give feedback about:.When documenting hacks / special use of Duplicati, there is no rule to choose what to document and what not.When documenting procedure X, you have to document many other related procedures (example: documenting moving Storage provider X to Y induces the need for documenting a lot of other migration scenarios.these subjects are quite dynamic (storage providers based on standard protocols like S3 or SSH come and go).What I’ve thought about, but didn’t make it to the manual is: “FAQ’s”, “Troubleshooting”, “Specific operations / Hacks / Tips & Tricks”, “Howto’s” and “Using specific Storage providers”. This completes all subjects I want to cover in the manual (General information, Installation, Graphical Interface, Storage Providers, Commandline Interface, Disaster Recovery, Commandline Reference, Advanced Options Reference, selected whitepapers in Appendices). In the mean time, things may evolve, and thoughts may change on what’s the best approach for releasing it to the public. When I download a program I want to try, I first click on the Support/Documentation/Features link and not dive straight into a discussion board to find out how things work.īut nothing has been decided yet, first let’s try to complete the docs as soon as possible. I’m not feeling very comfortable by the idea to put as much as possible in the forum, as I still see the primary usecase for a forum is discussion, mainly “User X helps User Y” and discussions about how to improve the product. ![]() I have thought of several options how to share it, but still not sure what the best option is and what’s technically possible. It’s probably also a good idea to add a link to the pdf manual at the beginning of each post, mentioning that what follows is an excerpt of that manual.
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |