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!

Best wishes

r


Ronán M Conroy, DSc

Royal College of Surgeons in Ireland

https://www.researchgate.net/profile/Ronan-Conroy

Prof. Ronan Conroy DSc
Professor Emeritus


[cid:RCSI-University-logo-RGB-155x100px_cc8d6c56-783c-4ef3-b1b2-1506aa9c1dcb.png]

Department of Epidemiology and Public Health Medicine
Block B, Ardilaun House, SSG Dublin 2 Ireland
T: 01-402-2431 M: 087-799-97-95
E: rcon...@rcsi.ie W: www.rcsi.com<http://www.rcsi.com/>


Discover why we are Top 50 in the World for 'International Outlook' - THE World 
University Ranking 2022<https://www.rcsi.com/international>


[cid:2022-04-28-the-graphic-single_559483d2-62ea-4234-8013-8027c230a24f.png]<https://www.timeshighereducation.com/world-university-rankings/rcsi-university-medicine-and-health-sciences>
       [cid:2022-04-28-athena-graphic_c556031a-bc9e-4e17-83ab-f8226018eb5d.png] 
<https://www.advance-he.ac.uk/equality-charters/athena-swan-charter>
[cid:2022-04-28-ibec-graphic_ff096800-e62f-4f4a-af72-bc3fbb5412aa.png]<https://www.ibec.ie/employer-hub/corporate-wellness/the-keepwell-mark-public-page>


If you receive this email outside of your normal working hours, you are not 
expected to respond until you return to work.

Registered Charity Number: 20001957
-- 
lyx-docs mailing list
lyx-docs@lists.lyx.org
http://lists.lyx.org/mailman/listinfo/lyx-docs

Reply via email to