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

learn more… | top users | synonyms

0
votes
1answer
40 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 ...
-1
votes
1answer
677 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
2answers
222 views

What markup languages are good for programming articles/tutorials?

I very much wish to write a programming tutorial in my native language (Latvian). There are far too few of those. I am however unsure on what markup language to use for writing it. Here are a few ...
2
votes
3answers
253 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
162 views

How does one write a book on a new framework?

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 ...
15
votes
8answers
685 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 ...