I am working on a project where I need to make an end-user document for software, At the point, I am writing this document, which will retire the piece of software. Therefore, I do not want to spend a lot of time on professional-grade manuals. There is something that a college graduate and some of the home professionals may be looking at. Although it is good and useful, I will feed it back in the OpenSource community as a free document.
I was thinking that an HTML manual would be a good fit, the software was written in PHP, so anyone with whom a person is using will have a web browser open and he will be ready. It also gives the possibility of integrating me or some other manual pages into the software.
I am not interested in making / making wiki for this part of the software. What I'm actually seeing is a piece of software where I can write like a normal document and generate simple HTML. I know pieces of software such as DreamWire and FrontPage, but I was particularly interested in some of the designs to simplify the process of documentation (where the process of taking screen-caps and video integrated with simple image / video editing has been done).
If you think another approach (other than HTML docs) may be better, then I would love to hear it. If you have another approach, and you feel that you know a good software solution to achieve it, then let me know.
My main desires for getting approach and software
- Simplicity in deployment (HTML pages do not require any special setup. Pages can be simply deployed with)
- No special software is required to use (HTML can be read by every single web browser)
- For me Documentation / short learning hours Writing (I do not want to spend a lot of time learning a complex piece of software to work on a relatively small project)
- Ability to add text, video and images to individual documents (HTML page clearly To support them all at once)
Thanks! @Li Ryan: "MediaWiki stores all the text and data (content page, user details, system messages, etc.) in a database ..." which I want to save, I think the wiki Great and useful, but I'm interested in providing stable data with very little overheads.
Whenever I need to write user manual (which means that I run a project every time I do), I want to use. Combining with minimal CSS, it is very easy to use.
Markdown is a text-to-HTML conversion tool for web authors. Markdown allows you to write a simple-to-read, easy-to-write plain text format, then it can be structured converting to XHTML (or HTML) valid.
Thus, "Markdown" is two things: (1) a plain text formatting syntax; And (2) a software tool written in Perl, which converts plain text format to HTML.
Comments
Post a Comment