According to Wikipedia, writing is a medium of communication that represents language through the inscription of signs and symbols.
1
vote
1answer
87 views
Is there an easy way to type in common math symbols?
Disclaimer: I'm sure someone is going to moan about easy-of-use, for the purpose of this question consider readability to be the only factor that matters
So I found this site that converts to easting ...
6
votes
1answer
103 views
Common Methodologies for Writing “Post-Mortem” Reviews [closed]
We recently added a relatively large feature to our product that involved the entire R&D department (with all the different teams within it).
This feature included UI development, server side ...
1
vote
1answer
203 views
How to present code in academic work?
Actually, I'm writing my undergrad thesis, that consists in analysing the BitTorrent algorithm and see its application on Transmission client as an example of implementation.
Reading through its ...
11
votes
5answers
2k views
What grammatical tense should I write my specifications in?
We are currently writing functional and technical specifications in a two column format; summary sentence and technical detail. The details often refer to an appendix with diagrams, layout designs ...
2
votes
2answers
215 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 ...
36
votes
18answers
2k views
How can I improve my technical writing?
Writing documentation is part of programming, and writing well
is part of what makes the documentation useful.
So, what are some hints or guidelines for good writing in the
technical realm? What are ...
22
votes
8answers
2k views
How do you write technical blogs? [closed]
I usually read a lot about programming related stuff. When the topic I read is not related to my work directly ,(say reading about some Algorithms which I don't use in everyday work), I forget them.
...
2
votes
3answers
247 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 ...
7
votes
6answers
630 views
Does long term programming affect writing in a native spoken languages? [closed]
So, I am getting some years under my belt in long term programming. I have noticed, however, when the frequency and duration started increasing in my coding sessions that when I actually went to ...
2
votes
2answers
537 views
Write a directory structure (pseudo code) [closed]
I am writing a wiki article and wondering what is the proper way to write a directory scheme?
I am doing something like
main folder
- sub folder
- sub folder
...
But I'm stuck after that.
Any ...
4
votes
2answers
9k views
Where can I find examples of functional specifications? [closed]
I am writing a functional specification for a software program (Mac OS X application to be exact). I want to improve this by looking at other (good) functional specifications, but I cannot find any.
...
3
votes
5answers
547 views
What programming magazines pay for articles from guest writers? [closed]
Do any programming magazines accept contributions and pay the authors for them? If so, what magazines are these, or how can I go about finding them?
2
votes
5answers
333 views
Run On Sentences in Technical Writing
This is just a question to think about.
When you write technical documentation and programming comments, do you ever find yourself writing run-on sentences in order to be more precise?
Is packing ...
20
votes
15answers
2k views
Motivating yourself to actually write the code after you've designed something
Does it happen only to me or is this familiar to you too?
It's like this: You have to create something; a module, a feature, an entire application... whatever. It is something interesting that you ...
1
vote
4answers
775 views
General tips on writing specs for Java programmers [closed]
I found myself in a pickle after writing some specs for freelance programmers that I hire.
It seems that I'm missing some basic structure and I'm not placing the points in clear enough view for the ...
8
votes
4answers
229 views
Programming in other writing systems such as those who write right-to-left
How do programmers in countries whose writing system is, say, right-to-left write their code? Say if they were using C# compiler, do they follow the left-to-right approach or do they have a different ...
7
votes
7answers
559 views
What is the best toolkit for writing long technical texts?
I'm looking for a toolkit in the form of one or a couple of applications that can be used to write long technical texts (such as an introduction to a programming language).
What applications (or ...
8
votes
1answer
3k views
how do I write a functional specification quickly and efficiently
So I just read some fabulous articles by Joel on specs here. (Was written in 2000!!) I read all 4 parts, but Im looking for some methodical approaches to writing my specs.
Im the only lonely dev, ...
5
votes
2answers
418 views
API/Technical Writers Guide [closed]
Is there any good book/tutorial/guide for programmers, which can help them to write good programming documentation/tutorials/guides?
14
votes
12answers
978 views
Do poor writers make poor programmers? [closed]
I'm reading Coders at Work by Peter Seibel, and many a time it has been mentioned that programmers who can't write generally make poor programmers - it's been claimed by Douglas Crockford, Joshua ...
9
votes
6answers
345 views
How do you keep emails short but complete? [closed]
I'm the odd kind of developer that likes writing and explaining - emails, specs, you name it. I enjoy helping people understand things deeply. I hate ping-pong communications where groups go through ...
6
votes
2answers
173 views
Is it unreasonable to write user documentation in the style of a technical book?
Tell me if this sounds familiar:
something something something... as seen in figure 1-1 on the next page...
It's in practically every book I've ever read about programming. So when I was ...
5
votes
4answers
187 views
What writing rules are different for humans and code?
It seems that some rules of writing code are in direct contradiction with the rules of human writing. For example in code it's advisable to define each piece of information in only one place and in ...
