Talk:Documentation Improvement

Page doesn't mention the translation process

I just noticed the following message on gnucash-devel:

http://lists.gnucash.org/pipermail/gnucash-devel/2015-February/038536.html

mentioning an implication of documentation updates to translations. Currently (16 February 2015) the documentation updates procedure doesn't even mention the translation process.

Twt (talk) 23:49, 16 February 2015 (UTC)

So? The wiki can't document everything, especially when it comes to craft knowledge.

But links are cheap in a wiki. ;-) Done. --Fell (talk) 14:57, 17 February 2015 (UTC)

Thank you VERY much for the link! I believe that link is a very helpful cue.

The email above suggested adding comments (for translators to see) embedded in the DocBook source to point to major rearrangements or added sections. I haven't yet looked through the existing source for such comments, but my thought was if they are helpful this page could suggest where and how to add them, following whatever convention has already been established. [UPDATE: A quick glance through a few chapters shows this particular suggestion really applies ONLY to the Book file, and not to any of the chapters, at least not as they are written now.]

The page collects a few similar "conventions" at the end (including one begging for more). The documentation trade calls those notes a "style guide." Twt (talk) 07:41, 18 February 2015 (UTC)

UPDATE: Thanks Fell for the update! You added the sort of suggestion I was imagining, directly in a procedure. (In step 4 of the Documentation Change Process section.) Twt (talk) 18:05, 18 February 2015 (UTC)

Changing this page from "Documentation Update Instructions" to "Documentation Improvement" is incorrect, improper, and misleading. The original title was accurate and succinct. PUT IT BACK. sunfish62@yahoo.com