[erlang-questions] FOP (was: Re: Trace-Driven Development)
Bengt Kleberg
bengt.kleberg@REDACTED
Thu Jun 7 08:07:45 CEST 2012
My first job allowed me to work with 2 technical writers. They had spent
3 years learning how to do technical writing. They where much better at
this than the people that had spent 4 years learning engineering.
If this was solely because of the education, or a result of wanting to
do the job so much that they took the time to learn it, I do not know.
bengt
On Wed, 2012-06-06 at 00:53 +0200, Richard O'Keefe wrote:
> On 6/06/2012, at 3:30 AM, Michael Turner wrote:
> > But really: just give me a wiki. Give everybody a wiki. Write scripts
> > to update the repo from the wiki diffs, if that's so important.
>
> For the sake of suffering humanity, forfend!
>
> The next time someone offers me a wiki instead of documentation,
> I am going to be exceedingly angry. I have never yet found any
> wikified documentation that was worth printing to wipe my arse with.
>
> I do apologise for the vulgarity, but good documentation needs
> good technical writing and technical writing is a skill that is
> distinct from programming, although some people can do both well.
> It needs a *global* view as well as attention to fine detail.
>
> > Generally, lower the bar for entry, for those who want to improve the
> > documentation, and the documentation *will* improve.
>
> Someone recently wrote something about the sky turning green then
> yellow, didn't they? How is *lowering the bar* going to result in
> anything *improving*? It might get more *voluminous*, but better?
>
> What we really need is a small number of good technical writers
> and money to pay them.
>
> _______________________________________________
> erlang-questions mailing list
> erlang-questions@REDACTED
> http://erlang.org/mailman/listinfo/erlang-questions
More information about the erlang-questions
mailing list