New answers tagged

0 votes

Is it a good idea to use Git for document management of technical documentation?

You may want to consider checking out Google Docs, as I believe they offer version tracking. While I have heard of it, I have never personally used this feature. As a developer by trade, I enjoy ...
Lynn's user avatar
  • 111
0 votes

Is it a good idea to use Git for document management of technical documentation?

If you don’t have access to a tool to effectively diff the pdfs I imagine this approach will be suboptimal. Especially considering you have the original MS files, which are text -- the extensions ...
EDL's user avatar
  • 11.7k
4 votes
Accepted

Is sacrificing "clarity" for sounding smarter on a college continued interest letter a good idea?

About the opposites and the reader I agree that it is problematic setting up 'clarity' and 'sounding smarter' as opposites, but I get that you do not intend for this to be the case. With clarity you ...
storbror's user avatar
  • 2,646
0 votes

Technical Documentation and Training System Utilizing Markdown and Live Updates

I'd say any wiki will do this, but MediaWiki (Wikipedia's system) and DokuWiki are the ones I know. The basic logic behind most Wikis was originally that they expose the system to "whomever" ...
Erk's user avatar
  • 6,048
1 vote

Technical Documentation and Training System Utilizing Markdown and Live Updates

GitBook checks all your boxes. It uses Markdown. It uses versioning with Git. On its upper tier plans, it supports PDF exports. It supports both internal/private and public-facing docs. https://www....
minae's user avatar
  • 11
2 votes
Accepted

Optimal word distance

I think the best option here is to name the two approaches. For example: There are two ways problem "X" has been solved in the past. For the purpose of comparison we will call the first the ...
Amadeus's user avatar
  • 101k
2 votes

Optimal word distance

There is no rule of thumb, but it is unlikely that your readers will forget what problem X is because: The whole preceding passage (i.e. "The first is...") has put problem X in relation to ...
Ben's user avatar
  • 5,259
1 vote

Is it OK to repeat the word implied by an acronym?

One point not mentioned by the other answer is the use or otherwise of the definite article with the acronym. Personally (as a technical expert in the field of protocols) it sounds very weird to me to ...
Vicky's user avatar
  • 111
2 votes

Is it OK to repeat the word implied by an acronym?

That is sloppy writing! A good practice is to explain the acronym at least once at the beginning of the text, so your readers know what it means, and then use it the same way you would the full phrase ...
Ben's user avatar
  • 5,259
0 votes

Technical documentation of legacy system software

Here's a universal documentation tip: Look at documentation for similar products, systems, languages or software (depending on what your thing to be documented is). Copy (in the sense of replicate) ...
user8356's user avatar
  • 1,323

Top 50 recent answers are included