On Tue, Feb 14, 2017 at 6:36 AM, rengel <[email protected]> wrote:
> 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 management of his information. > > *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. > Good. > *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. > As I said earlier today, I am horrified by the amount of stupefying detail in the basic docs. Clearing away the blah-blah-blah should help a lot. I am not going to spend three months revising the docs. I am merely going to put as much as I can in subsidiary (reference) pages. This is my choice. If you don't like it, feel free to suggest actual better docs. *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 projects using main computer languages, > - create and edit the documentation for such projects. > Reasonable. Programmers are used to reading references as primary sources. *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. > All this is good, but I am going to spend most of this year doing what I *alone* can do, which is to guide the creation of urgently needed capabilities to Leo. Leo must catch up with org mode and pyzo. *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.) > A laudable goal. Imo, this forum, Leo's bug tracker and maybe irc are the ways to make it happen. *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.) > Life is too short for such things. Certainly *my* life is too short for such things. I welcome all help with documentation. Many people are better than I at writing stories. My brother certainly is. Edward -- 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.
