Search type Search syntax
Tags [tag]
Exact "words here"
Author user:1234
user:me (yours)
Score score:3 (3+)
score:0 (none)
Answers answers:3 (3+)
answers:0 (none)
isaccepted:yes
hasaccepted:no
inquestion:1234
Views views:250
Sections title:apples
body:"apples oranges"
URL url:"*.example.com"
Favorites infavorites:mine
infavorites:1234
Status closed:yes
duplicate:no
migrated:no
wiki:no
Types is:question
is:answer
Exclude -[tag]
-apples
For more details on advanced search visit our help page
Results tagged with Search options user 29907

Documentation, tutorials, training, user guides, installation guides, design documents, and all other types of technical documentation in any domain (not just software).

3
votes
Unfortunately, your link to resource refuses to resolve for me, so I cannot directly comment on the terms they've listed - I can tell you that most openly available GIS data will have a terms or discl …
answered Sep 19 '18 by GerardFalla
3
votes
Long ago, I used to write manuals for large, complex machines, and so had a lot of part number references; I've seen (and used) Part Number 123456, PN 123456, P/N 123456, Number 123456, N123456, No. 1 …
answered Mar 7 '18 by GerardFalla
4
votes
I can add that more than a decade ago, I was senior tech writer with an engineering & manufacturing firm whose product was used in semiconductor fabs, and when I started, the vast preponderance of the …
answered Jan 24 '18 by GerardFalla
4
votes
As a technical illustrator as well as technical writer, I most frequently generate my own illustrations, and frequently provide that service for others, however I don't think it a reasonable expectati …
answered Jan 24 '18 by GerardFalla
1
vote
I saw a post on exactly this idea on WtD slack channel a few days back - I want to say the approach was called typson+docson, and was directly pulling comments into a documentation system off the bat …
answered Feb 16 '18 by GerardFalla
5
votes
I'll add my prior experience to this: the purifier company for which I worked long ago used PLCs for controls on their more complex devices, and had previously spent huge time and effort to write conv …
answered Feb 6 '18 by GerardFalla
1
vote
In the broader technical writing field, we often consider the Flesch Reading Ease metric, and the Flesch-Kincaid Grade Level metric, and the underlying assumption tends to be that one should write for …
answered Feb 27 '18 by GerardFalla
1
vote
There's a whole movement of folks working in the technical documentation field who are not "technical writers" or "technical authors" per se, but who care deeply about good documentation, and many are …
answered Sep 12 '18 by GerardFalla
4
votes
If one assesses this not in terms of data capture, quantitative analysis and other hard metrics, but from the user experience and sociological/psychological/behavioural direction, the implications are …
answered Feb 16 '18 by GerardFalla
4
votes
Multi-story apartment block, single-loaded exterior balcony over colonnade. Single loaded refers to all apartments being on one side of a corridor, hall or other accessway / circulation path. Exteri …
answered Mar 1 '18 by GerardFalla
0
votes
Based on the communications model used in physical engineering and architecture, the correct answer is "refer", whether the data occurs in long technical documents, specifications or in the final cons …
answered Feb 6 '18 by GerardFalla
1
vote
There is another consideration: your client may be referring to inverted-pyramid writing. Front-load crucial data and answers in order to grab the reader quickly, to aide the reader in scanning for da …
answered Mar 1 '18 by GerardFalla