[Please keep Ronan in Cc:, he is not subscribed to the list]
Le 05/05/2022 à 15:05, Pavel Sanda a écrit :
On Thu, May 05, 2022 at 11:37:55AM +0000, Ronan Conroy wrote:
I???ve started learning to use LyX, and am impressed by it as a editor.
However, as someone who has written documentation for software, I would like to
point out a couple of things
1. Tutorial material is prolix. There is simply too much prose. Focus each
paragraph on acquiring a definable skill, and use each skill to teach a useful
concept. Focus on the skills that the person needs to get going.
2. Tutorial material is inaccurate as regards word processors. It describes
making a list, for example, as the tedious process of numbering and indenting
items. This has not been true of standard word processors (Libre Office, Pages,
Word) for decades. Save space by leaving word processors out of the material.
People are using LyX because they want a TeX interface. They have a word
processor and know its limitations.
3. My first software documentation job was to take the manual for the word
processor (DSR ??? a mainframe markup program running on an old Dec-20
mainframe) and write an instruction manual that could be printed on one side of
an A4 card. It was wildly successful. You need one of these.
The app is great. You just need people to write cheerful, lucid documentation.
I itch to volunteer, but I???m already over-committed!
Dear Ronan, thanks for your feedback.
Let me introduce you to our situation :)
Currently we do not have any person actively working on our primary
documentation or even 'overseeing' it.
That means when currently someone codes new feature he adds few paragraphs
about its existence into some of the manuals and that's it.
And coders are usually not the best writers for general public, most of us are
not even native english speakers...
Once in a decade someone pops up, says 'Hi guys, your manuals need editing
work, I can review it for you.'
We include his fixes, send our thanks and then manuals rot for next couple
years :)
So any help appreciated, whether fixes/rewrite our A4 cheat card, whatever
you'd enjoy!
Cheers,
Pavel
I can only concur with Pavel, the manuals are kind of up to date, but
there is no editorial vision anymore.
Documentation is one of our soar points, and we need someone who can
improve it.
JMarc
--
lyx-docs mailing list
[email protected]
http://lists.lyx.org/mailman/listinfo/lyx-docs
