Web lists-archives.com

Re: de-alphabetizing the documentation




Hi,

Frederick Eaton wrote:

>       Unfortunately my contribution will have to be limited for the
> moment to making this suggestion, as I am extraordinarily busy. I hope
> it will not be too burdensome to add this item to your TODO list and
> keep it there until a willing volunteer comes along.

No problem.  If you have time to contribute later, we can wait. :)

> For what it's worth, I made extensive changes to the Arch Wiki Git
> article back in 2015, following an initial attempt of mine to
> understand various tutorials. It was the most prominent wiki-based Git
> documentation I could find at the time. The article has of course seen
> numerous improvements since then.

For reference: https://wiki.archlinux.org/index.php/git

> I don't think that it's really important to find a "best" ordering for
> commands or glossary terms; it's more a matter of finding someone who
> is willing to take responsibility for choosing a reasonable ordering.
> Presumably the head maintainer of this project could delegate the task
> to a qualified volunteer, not a newbie like myself but not necessarily
> someone with expert knowledge either.

I'd have to say, when I compare the troubles a new user and a
long-timer would run into, I conclude that the long-timers would be
more likely to produce worse documentation.  It is very difficult to
remember how new users see things.  The ideal skill set in fact has
nothing to do with level of Git expertise: to produce a good result, a
good technical writer would ask the right questions to gather
information from the experts and then test their documentation on
newcomers until it works well.

Based on the work you've described already having done, it sounds like
you'd be an ideal person to get this going, if you find yourself with
time for it.

>                                       It's too bad that a policy of
> not listing things alphabetically wasn't adopted from the beginning of
> this project, but I guess that's life.

>From this thread I've been convinced that for this kind of reference
document, alphabetical organization within each section is a good
organization, provided each section is small enough (as in "git help"
output).

I'm also a fan of non reference documentation that can use a narrative
ordering instead (like "git help core-tutorial", except with more
modern commands).

> Thanks Eric for the pointer to "git help". This does indeed provide a
> finer and better grouping than the man-page (but it also looks like
> another candidate for de-alphabetization...!).

Indeed, copying that organization over from "git help" to the git(1)
manpage may be a good step for any interested people overhearing this
conversation.

As a first step, how about making git(1) recommend "git help", like
this?  It already recommends giteveryday(7) but the more interactive
first command might be useful for some people.

Thoughts?  Improvements?

-- >8 --
Subject: git doc: recommend "git help" as a starting point

The list of subcommands described in git(1) can be overwhelming.
Encourage newcomers to run "git help" to get a shorter list of
commands as a starting point.

Based on a suggestion by Frederick Eaton.

Signed-off-by: Jonathan Nieder <jrnieder@xxxxxxxxx>
---
 Documentation/git.txt | 9 ++++++---
 1 file changed, 6 insertions(+), 3 deletions(-)

diff --git a/Documentation/git.txt b/Documentation/git.txt
index dba7f0c18e..0149ce9af0 100644
--- a/Documentation/git.txt
+++ b/Documentation/git.txt
@@ -23,9 +23,12 @@ unusually rich command set that provides both high-level operations
 and full access to internals.
 
 See linkgit:gittutorial[7] to get started, then see
-linkgit:giteveryday[7] for a useful minimum set of
-commands.  The link:user-manual.html[Git User's Manual] has a more
-in-depth introduction.
+linkgit:giteveryday[7] and run
+
+    git help
+
+for a useful minimum set of commands.  The link:user-manual.html[Git
+User's Manual] has a more in-depth introduction.
 
 After you mastered the basic concepts, you can come back to this
 page to learn what commands Git offers.  You can learn more about
-- 
2.18.0.203.gfac676dfb9