All Questions
Tagged with technical-writing version-control
4 questions
1
vote
2
answers
112
views
Is it a good idea to use Git for document management of technical documentation?
I have compiled the technical documentation for a physical product. It includes documents like user manuals, technical descriptions, maintenance instructions, etc. I have decided that all these ...
0
votes
2
answers
91
views
Technical Documentation and Training System Utilizing Markdown and Live Updates
This may not be the correct place to post this question, but I'm at a loss of where else it can go.
I'm attempting to research a potential documentation system for my company to use that would replace ...
8
votes
4
answers
1k
views
Linking documentation to Git commit comments
Using git to track modifications to the project allows contributors to include comments with each commit. If the project's guidelines, and managers' control, keeps those comments limited to a format ...
8
votes
3
answers
2k
views
Best Tool to Create User Guides
We are planning to create a user guide for internal use only. It's 150-page document in Word for a self-developed SW tool. The user guide will require constant update. No translation is needed. We ...