Questions tagged [technical-writing]

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

6 questions with no upvoted or accepted answers
Filter by
Sorted by
Tagged with
2
votes
0answers
106 views

Effort equivalence between video course and written course

If 1 page of a technical course is worth 1 point, how many points is 1 hour of a technical video course worth, creation effort-wise? Background and context: I work in academia in a technical field (...
0
votes
1answer
28 views

Citation throughout my book rather than at the end as a bibliography

My book is a health/ wellness/ diet book/ metabolic issues etc. Throughout my book which I am 3/4 of the way through I have added in the website links after a piece of evidence. I have used 95% of my ...
0
votes
0answers
29 views

Best way to explain references to historic currency

What is the best way to explain the pre-decimal British Pound in a text that has multiple references to it. I already have something written to explain how to convert from pre-decimal to post-decimal ...
0
votes
2answers
108 views

Writing about the historical relationship between math and physics

I'm not sure if this is best suited for Writing SE, or perhaps one of the science SE's. In any case, feel free to move this if fitting. I've been tasked with writing a 20-30 page paper on the history ...
0
votes
0answers
31 views

How should I structure a small non-fiction book/paper about a groundbreaking product/invention?

I want to write a book/paper about an invention I have thought and developed conceptually. But I'm really struggling on what I should include in it and how to structure the information. Any ...
0
votes
0answers
40 views

Constructing a standardized form for a collection of technical manuals

I've been reading several articles about the use of voice within technical writing (both passive and active) and would like feedback and guidance on the proposed content structure. Use Case I plan on ...