Maksakovsky-admin / technical

0 stars 0 forks source link

tech-indexing #13

Open dentarthur opened 5 years ago

dentarthur commented 5 years ago

Will take a while before I organize info relevant for you in tech-indexing.

But orienting in this direction will eventually be less likely to end in oblivion. Hopefully it will also result in contact with technical writers who we need to be working with. Its the same sort of qualitative leap from MS Word to this stuff as you have already done from Windows user to jekyll. Could actually be easier as software like Framemaker and Madcap Flare aimed at technical writers previously using MS Word rather than at IT workers.

Meanwhile the references in tech-indexing/references can be found in your folder:

Publishing/Indexing-References/

The books are in ../Indexing-Books - mostly irrelevant but some useful

Software in ../Indexing-Software/

Of these ../Madcap_Flare looks to me superior to Framemaker though I have no idea whether we can get it. Works with DITA input and output and has vast documentation in:

../FlarePDFs (extracted from ../FlarePDFs.zip)

Suggest a quick look at:

FlareKeyFeaturesGuide.pdf FlareIndexingGuide.pdf

I am assuming we will end up doing most writing in Github Flavoured Markdown with the minor additions needed for Lightweight DITA, LwDITA. It should be possible to combine short topics written that way into DITA for publication with just XML editors and other freely available software. But even if we have to do it that harder way, the extensive documentation provided for Madcap Flare could be very useful to understand what needs to be done.

Also nearby are some books in ../Framemaker/

Likewise even if we end up using Framemaker 2019 with DITA, the Madcap Flare docs could be helpful as the easily available Framemaker books above are quite old.

Also nearby is some stuff on ../Cindex_3.0/ specifically for professional indexers. I haven't checked out the others but this looks plausibly usable and helpful.

The references for DITA from tech-indexing/dita can be found scattered in your folders with names that include DITA.

In particular see /Publishing/DITA/DITA_Books/

within that you will find ../New_DITA_Books/ which has preview of recent book on LwDITA that I have asked Peter to get hold of:

Creating_Creating_Intelligent_Content_with_Lightweight_9781351187510_preview.pdf

The example on p26, pdf 47/60 shows what the MDITA markdown would look like. Rest of preview suggests to me that it would be feasible for us to work that way.