Questions tagged [technical-writing]

Technical writing refers to writing on programming and technical-related topics.

Filter by
Sorted by
Tagged with
2
votes
2answers
144 views

Is there a standard way to refer to items inside a menu when writing documentation?

At several times in the past while writing software documentation -- including user manuals, user stories, bug reports, test cases, and emails to users/colleagues -- I've needed to be able to refer to ...
1
vote
3answers
13k views

Who should write the Technical Design Document? The BA or the Developer? [closed]

I work as a Snr. BA in a large Manufacturing company and I've just implemented a new Requirements Management Process. We have a large range of internal developers who in the past have never been ...
2
votes
1answer
180 views

Formulate release notes consistently

In my project, I came across understanding that writing release notes is both helpful and necessary. However, it is not required by my management and I keep these files virtually to myself. You could ...
3
votes
1answer
5k views

JIRA Ticket Best Practices: How to write a good JIRA ticket [closed]

We "use" JIRA as our ticketing system, but "use" is a real stretch. We have no standards, no templates, no "best practices" documentation for writing a proper JIRA ticket. So I'm spearheading the ...
3
votes
3answers
366 views

What is a good rule of thumb to do technical writing that doesn't confuse people

Sometimes I'm such a nerd that not even nerds understand me, or rather, sometimes I cannot put stuff in understandable and simple-enough terms... and sometimes I can but cannot really tell until after....
5
votes
1answer
198 views

How does one write a book on a new framework? [closed]

How are authors able to write a book on a framework that is just released? A framework like spring is updated, and a book is released in the next day. Is this typically by people who are direct ...
13
votes
5answers
602 views

Idea for a physics–computer science joint curriculum and textbook [closed]

I want to write (and have starting outlining) a physics textbook which assumes its reader is a competent computer programmer. Normal physics textbooks teach physical formulas and give problems that ...