Let me give it a try. The following describes how I would approach the documentation task. I see at least three distinct target audiences: newbie non-programmers, programmers at large, and Leonistas. For each of them the documentation must be different.
*Target audience:* *Newbie non-programmers*. A *newbie non-programmer* is a computer user who is not interested in programming but could use an outliner to improve the mangement of his informations. *Goal:* Enable newbie non-programmers to use Leo for creating and organizing documents. After reading this documentation the person - is familiar with the Leo terminology, - is able to create, update, delete, load, save, import, and export documents using Leo, - is able use cloning and/or hoisting to improve her productivity. *Strategy:* Review, select, edit and rewrite/write existing Leo documentation and tutorials pertaining to this goal. Explain the main Leo concepts. Create texts/screenshots/graphics/videos that describe the Leo user interface and guide the person step-by-step through the operations described in the 'Goal'. *Schedule:* Three months. ---- *Target audience:* *Programmers at large*. A *programmer at large* is a programmer who wants to work on multiple projects and to edit, test, run, and organize programs in or more computer languages and the corresponding documentation, but is not interested in programming the tools using Python. *Goal:* Enable programmers at large to use Leo for creating and organizing documents. After reading this documentation the person - is able to setup and use Leo as an development environment, - manage programming prjects using main computer languages, - create and edit the documentation for such projects. *Strategy:* Review, select, edit and rewrite/write existing Leo documentation and tutorials pertaining to this goal. Explain the use of Leo as an IDE. Show how to use different editor modes (native, Emacs, Vim). Create texts/screenshots/graphics/videos that describe the Leo user interface and guide the person step-by-step through the operations described in the 'Goal'. Explain editing strategies using cloning and hoisting. Create a list of 'Best Practices'. *Schedule:* Three months. --- *Target audience:* *Leonistas*. A *Leonista* is a programmer who wants it all. (Experts to the front. I'm not really qualified to give a good definition here.) *Goal:* Enable Leonistas to use Leo to adapt and optimize their development environment and development through scripting using Python. (Experts to the front. I'm not qualified fill in the details.) *Strategy:* Review, select, edit and rewrite/write existing Leo documentation and tutorials pertaining to this goal. Explain how Leo can be scripted. (Experts to the front. I'm not qualified fill in the details.) *Schedule:* ???. That's about it. It's all too easy to mix *one's own goals* (creating the doumentation) with the *instructional goals* of the documentation. *Instructional goals* describe what a member of the target audience should be able to do after reading the documentation, not what one wants to accomplish (*your *goal above). Why three target audiences? - Not every computer wants to programm. But almost every computer user can benefit from an outliner. - Not every programmer wants to program their IDE or to learn Python. But every programmer can benefit from a powerful organizing tool for projects and programs Of course, any of the above stated goals and strategies should be elaborated. These are just my first thoughts on the documentation task. Greetings! Reinhard -- You received this message because you are subscribed to the Google Groups "leo-editor" group. To unsubscribe from this group and stop receiving emails from it, send an email to [email protected]. To post to this group, send email to [email protected]. Visit this group at https://groups.google.com/group/leo-editor. For more options, visit https://groups.google.com/d/optout.
