[svn.haxx.se] · SVN Dev · SVN Users · SVN Org · TSVN Dev · TSVN Users · Subclipse Dev · Subclipse Users · this month's index

Re: [TSVN] Created a repository...now what?

From: Simon Large <simon_at_skirridsystems.co.uk>
Date: 2005-10-03 11:00:04 CEST

Thomas Hruska wrote:

> Good for you. I happen to be a __very__ slow reader probably because
> I memorize just about everything I read. Most people are done
> reading a chapter or two while I'm still reading the third page for
> the second time. With technical documentation, my approach is to
> hierarchically analyze the content from chapters titles and subtitles
> and pick and

If you _had_ expanded the daily use guide chapter to see the titles and
subtitles, you would have seen all the topics you needed.

> choose what to read based on what I want to accomplish because
> reading the entire documentation would take me a week and most
> technical documentation is designed to NOT be read like a book.

Well this doc is pretty much like a book. Not everyone likes that, but
that's the way it is right now.

[snip]

> If I did that, you can bet your britches that other people do too.

Yes, you're right. We get a lot of questions from people who simply
haven't read the docs. Sometimes things are not as clear as they could
be, but unless you can come up with suggestions instead of complaints,
there's not much we can do.

One thing I could do is to add a 2-line summary of what each chapter is
about right at the start.

Somewhere you comment that users should not have to read the docs. Maybe
that's true of some programs, but if you are trusting your precious
source code (or other important data) to a VCS, then you should
_definitely_ read the docs before you start out.

Simon

-- 
        ___
   oo  // \\      "De Chelonian Mobile"
  (_,\/ \_/ \     TortoiseSVN
    \ \_/_\_/>    The coolest Interface to (Sub)Version Control
    /_/   \_\     http://tortoisesvn.tigris.org
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tortoisesvn.tigris.org
For additional commands, e-mail: dev-help@tortoisesvn.tigris.org
Received on Mon Oct 3 11:00:14 2005

This is an archived mail posted to the TortoiseSVN Dev mailing list.

This site is subject to the Apache Privacy Policy and the Apache Public Forum Archive Policy.