From: "Mann, Benjamin (Jr)" <ben.mann@hp.com>
To: <gdb@sources.redhat.com>
Subject: FW: [Gdb-discuss] Style Conventions for Documentation?
Date: Wed, 09 Jun 2004 16:27:00 -0000 [thread overview]
Message-ID: <85896742E37AAA47AA56CB578CB4173B062EFB02@tayexc18.americas.cpqcorp.net> (raw)
Hello,
Can you help me out? I am looking for style convention information used
in the GNU documentation, if such guidelines exist.
Jim Blandy recommended I submit the query to you. If there's a better,
more appropriate way to find the information I seek, please let me know.
See my message (and Jim's reply) below.
Thank you.
***************************
Ben Mann, Jr.
Hewlett-Packard Company
110 Spit Brook Road
Nashua, NH 03062
e-mail: Ben.Mann@hp.com
telephone: 603-884-3477
-----Original Message-----
From: jimb@zenia.home [mailto:jimb@zenia.home] On Behalf Of Jim Blandy
Sent: June 09, 2004 12:16 PM
To: Mann, Benjamin (Jr)
Cc: gdb-discuss@gnu.org
Subject: Re: [Gdb-discuss] Style Conventions for Documentation?
"Mann, Benjamin (Jr)" <ben.mann@hp.com> writes:
> I am a technical editor who has been asked to review the HP WDB
> version of Debugging with GDB. Please forgive my ignorance of
> information that may be readily available; this is my first exposure
> to open source documentation. I have been unable to find any
> guidelines or reference information on your Web site about the
> preferred writing style and typographic conventions for GNU-related
> documentation.
>
> Do you have, or know where I might find, a listing of typographic
style
> conventions that are recommended for use in the documentation?
Because
> there have been many contributors to the documentation (from many
> companies and with different points of view), many styles are
> implemented for similar items. For example, sometimes command options
> are in single quotes, sometimes not. Or lead-ins to lists or code
> examples sometimes end with a colon, sometimes with no punctuation,
> and sometimes with a period.
>
> As an editor I value consistency (among other things like clear
> writing, conciseness, and so forth), so I am looking for any guidance
> about writing style preferences you have or know of, if any.
>
> Thank you for any direction you can provide.
Probably the best place to post this question would be
gdb@sources.redhat.com. Eli Zaretskii <eliz@elta.co.il> is our
documentation maintainer; he's listed in gdb/MAINTAINERS.
next reply other threads:[~2004-06-09 16:27 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2004-06-09 16:27 Mann, Benjamin (Jr) [this message]
2004-06-09 19:33 ` Eli Zaretskii
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=85896742E37AAA47AA56CB578CB4173B062EFB02@tayexc18.americas.cpqcorp.net \
--to=ben.mann@hp.com \
--cc=gdb@sources.redhat.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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox