Tool for documentation
-
Hi there champs!
Not sure if it will be better to post this question here or in water cooler section, so bare with me
So, the question is what tool would you guys recommend for creating and maintaining of the technical documentation?
Basically, the requirements for the tool are :- Export the source content into the PDF
- Export the source content into HTML
- It should be able to merge few articles or documents into one output file
- It should be able to work with repositories
- It should keep versions of the document
Those are "must have" features.
Obviously, it would be great if the tool would be not overcomplicated and handy.
Ideally, it should be some kind of KB engine that could do all of the mentioned above, plus separating the articles for public view and internal usage.
Thanks in advance!
-
I think Confluence and Jira tick all the boxes you are looking for.
-
@coliver thanks for that!
Actually, that was my very first idea, but I couldn't find anything that would indicate that it can merge few docs/articles into one. Do you think it can do that? -
@original_anvil said in Tool for documentation:
@coliver thanks for that!
Actually, that was my very first idea, but I couldn't find anything that would indicate that it can merge few docs/articles into one. Do you think it can do that?Let me check our instance. I don't think it can now that you point that out.
-
@coliver said in Tool for documentation:
@original_anvil said in Tool for documentation:
@coliver thanks for that!
Actually, that was my very first idea, but I couldn't find anything that would indicate that it can merge few docs/articles into one. Do you think it can do that?Let me check our instance. I don't think it can now that you point that out.
Thanks!
-
Is the merging really that critical in a single action? You can print all things to PDF, then merge those PDFs yourself outside the doc manager. Not perfect, but workable.
-
@Dashrender well... it would be handy. I know that your option will work as well, but I'm sure you will agree that it is better to use one tool for one task instead of two or more.
-
@original_anvil said in Tool for documentation:
@Dashrender well... it would be handy. I know that your option will work as well, but I'm sure you will agree that it is better to use one tool for one task instead of two or more.
Oh absolutely! Anything you can do to make the end user's job easier it definitely a good thing. I just wouldn't have that item on my requirement list, instead it would be on the, should/really want to have list.
-
@Dashrender said in Tool for documentation:
@original_anvil said in Tool for documentation:
@Dashrender well... it would be handy. I know that your option will work as well, but I'm sure you will agree that it is better to use one tool for one task instead of two or more.
Oh absolutely! Anything you can do to make the end user's job easier it definitely a good thing. I just wouldn't have that item on my requirement list, instead it would be on the, should/really want to have list.
Gotcha! Well, not having that functionality is not a stopper, but highly desirable feature