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

learn more… | top users | synonyms

0
votes
1answer
53 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 ...
0
votes
1answer
1k 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 ...
2
votes
3answers
257 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 ...
5
votes
1answer
168 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
530 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 ...
15
votes
8answers
905 views

What are technical writing principles? [duplicate]

As a programmer, technical writing is an important skill to me. I get a lot of fun from it. I also learned from some good technical articles and books. What I need are technical writing principles or ...