Concept: Organization of documentation

[hoppfrosch]

Hi Avi,

just trying to do some supporting works on documentation of Clipjump. Therefore I want to hear your opinion/wishes to do the things right.

Just a few thoughts/objections:

• Should linkification be enhanced? (for example "Action mode" is mentioned on many pages - without linking to the corresponding anchor. This is the case for many possible links ...)
• You changed documentation style over time: In the beginning you had unified pages, describing all aspects of a feature (for example "Channels"). For new features you introduced separate pages for new features (for example "Channel Organizer"). Which is the desired way to go: integrate pages for new features on existing pages (if it makes sense) - or splitting topics out of overview pages (if its worth - for example "Action mode" as this seems a central concept ...)?
• You refer to concepts unless the definition is not clear (for example "Channel selector" is referenced several times - unless the term "Channel selector" is not introduced properly.) This shouldn't be, as it's difficult to link to this terms ...
• Some things need to be reordered/reorganized (for example: current order of topics on channel page is: "Pit Channel" - "Protected Channel" - "PitSwap". Isn't PitSwap a "subconcept" of PitChannel - and should therefore be a subchapter of "Pit Channel"?)
• Index deserves a few more entries
• ...

I am motivated to do some of these things - if I know your "visions" of the documentation ....

[aviaryan]

Should linkification be enhanced? (for example "Action mode" is mentioned on many pages - without linking to the corresponding anchor. This is the case for many possible links ...)

Yes, links should be added to keywords but only where needed. For example, if in an HTML preview you have 5 lines where you have used the term "[Paste Mode]" 10 times , then the paste mode should not be linked at all places. Just one link near the middle so that a user reading nearby can reach there if he needs to. In other words, links should be at distant places.

You refer to concepts unless the definition is not clear (for example "Channel selector" is referenced several times - unless the term "Channel selector" is not introduced properly.) This shouldn't be, as it's difficult to link to this terms ...

If you go by the left side index, you will not meet the Channel Selector term before reaching the Channels page. Maybe the basic_help.html can be splitted in parts, so that a content link or continuous content links compose a complete page (just like AutoHotkey.chm) -

1. getStarted.html - From getting started to pasting formats
2. pastemodeadvanced.html - From fixate to selective windows clipboard
3. extrafeatures.html - Everything what is left ..

BTW, Copy File Folder paths and Copy File data should be out of the category "Paste mode features".