All of lore.kernel.org
 help / color / mirror / Atom feed
From: Abdelrazak Younes <younes@lyx.org>
To: Junio C Hamano <gitster@pobox.com>
Cc: Johannes Schindelin <Johannes.Schindelin@gmx.de>,
	Julian Phillips <julian@quantumfyre.co.uk>,
	Scott Chacon <schacon@gmail.com>, Petr Baudis <pasky@suse.cz>,
	git list <git@vger.kernel.org>
Subject: Re: markdown 2 man, was Re: Git Community Book
Date: Thu, 31 Jul 2008 13:24:00 +0200	[thread overview]
Message-ID: <4891A0D0.6060503@lyx.org> (raw)
In-Reply-To: <7vy73j418t.fsf@gitster.siamese.dyndns.org>

Hello,

Sorry for this irruption on this list. I am just a git user and casual 
reader of this list. I thought I could share my thoughts about this as I 
know a bit about document creation. Please ignore if this is not 
appropriate.

Disclaimer: I am involved in LyX development, so anything I said will be 
biased :-)

Junio C Hamano wrote:
> As I am not in "graphics and screencast" camp, I may probably not be able
> to offer much help improving his book, and I suspect some people on this
> list might feel the same way.  But that's is Ok --- we are not dumping the
> User Manual.

IMHO, documentation is best written by users, not developer. So, again 
IMHO, anything that could accommodate the _user_ for document writing 
should be done. An enthusiastic user is more likely to spend time 
writing documentation than a developer. For example, within the LyX 
project, most writers and translator are not developer.

Asciidoc or Markdown are tools that accommodate the _developer_, not the 
user. I understand that these markup language are ideally suited for in 
source documentation (thought I personally much prefer Doxygen). I also 
understand that launching a different application just to modify a line 
or two in the user manual seems cumbersome for the developer but IMHO, 
if you're serious about working on the documentation, you are not going 
to change a line or two and launching an external application is no big 
deal.

Now, about my shameless plug: LyX is ideally suited for structured 
documentation writing :-)

Abdel.

  parent reply	other threads:[~2008-07-31 11:25 UTC|newest]

Thread overview: 39+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2008-07-29 16:20 Git Community Book Scott Chacon
2008-07-29 16:28 ` Miklos Vajna
2008-07-29 17:09 ` Petr Baudis
2008-07-29 18:30   ` Scott Chacon
2008-07-29 18:42     ` Junio C Hamano
2008-07-29 19:00       ` Julian Phillips
2008-07-29 19:09         ` Junio C Hamano
2008-07-30 13:27         ` markdown 2 man, was " Johannes Schindelin
2008-07-30 19:32           ` Junio C Hamano
2008-07-30 23:48             ` Wincent Colaiuta
2008-07-31  0:13               ` Scott Chacon
2008-07-31  0:30               ` Junio C Hamano
2008-07-31 11:24             ` Abdelrazak Younes [this message]
2008-07-31 13:01               ` Stephan Beyer
2008-07-31 14:13                 ` Abdelrazak Younes
2008-07-31 14:33                 ` Abdelrazak Younes
2008-07-31 15:09                   ` Miklos Vajna
2008-07-31 15:29                     ` Abdelrazak Younes
2008-07-31 19:00                       ` Miklos Vajna
2008-08-01  0:45                   ` Junio C Hamano
2008-08-01  7:11                     ` Abdelrazak Younes
2008-08-01  9:46                       ` Thomas Rast
2008-08-01 10:19                         ` Abdelrazak Younes
2008-07-31 20:57               ` Jan Krüger
2008-08-01  7:50                 ` Abdelrazak Younes
2008-08-01 10:45                   ` Dmitry Potapov
2008-08-01 11:06                     ` Abdelrazak Younes
2008-07-29 19:34       ` Scott Chacon
2008-07-29 19:57         ` Junio C Hamano
2008-07-30 21:39     ` J. Bruce Fields
2008-07-29 17:43 ` Junio C Hamano
2008-07-29 18:25   ` Junio C Hamano
2008-07-29 19:29     ` Scott Chacon
2008-07-29 19:24   ` Scott Chacon
2008-07-29 22:34 ` Daniel Barkalow
2008-07-29 22:47   ` Junio C Hamano
2008-07-30 13:20     ` Bart Trojanowski
2008-07-30 18:27       ` Junio C Hamano
2008-07-30 13:31     ` Bart Trojanowski

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=4891A0D0.6060503@lyx.org \
    --to=younes@lyx.org \
    --cc=Johannes.Schindelin@gmx.de \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    --cc=julian@quantumfyre.co.uk \
    --cc=pasky@suse.cz \
    --cc=schacon@gmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.