Technical writing refers to writing on programming and technical-related topics.
Technical writing refers to writing on programming and technical-related topics.
Questions tagged [technical-writing]
10 questions
13
votes
5 answers
Idea for a physics–computer science joint curriculum and textbook
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 are solved with pen, paper and calculator. I want…
Ami
- 2,055
- 1
- 16
- 20
5
votes
1 answer
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 contributors? Are they basing it off of beta/alpha…
monksy
- 649
- 5
- 18
4
votes
1 answer
JIRA Ticket Best Practices: How to write a good JIRA ticket
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 movement to create such a doc.
It's bad. Real bad.…
herpylderp
- 2,017
- 3
- 21
- 27
3
votes
2 answers
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 items inside a menu. Sometimes ones nested…
user266462
3
votes
3 answers
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.
I like the details on technical stuff, I enjoy…
dukeofgaming
- 13,943
- 6
- 50
- 77
2
votes
4 answers
How do I write, review and coach better English language in documentation?
My job regularly involves writing and reviewing (in the form of pull requests) English prose in the documentation for our internal system, which solely faces other developers, in a strongly American firm spread around the world.
That writing falls…
Oli
- 525
- 1
- 4
- 4
2
votes
3 answers
Who should write the Technical Design Document? The BA or the Developer?
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 asked to define solution via a Technical Design…
Dazzar
- 39
- 1
- 1
- 2
2
votes
1 answer
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 say, I do it for self-organization. For each…
Pavlo Dyban
- 163
- 8
1
vote
1 answer
Given-when-then template for docstrings
Tests can be very nicely written down using the given-when-then style. Are there similar styles / templates for describing methods and classes in docstrings?
To clarify: There are many sites which describe the docstring format and give examples.…
gebbissimo
- 241
- 1
- 6
-2
votes
1 answer
An expression in the first line of the control flow statement
Is there a term or some short wording to refer to an expression in the "first" line of the control flow statement?
func() {
if (a == b) {
var = 1 + 1
return True
} else {
var = 5 + 5
return False
}
}
if ((a == b)
&& (c == d))…
john c. j.
- 491
- 3
- 9