Skip to content

Instantly share code, notes, and snippets.

@ParaplegicRacehorse
Last active June 6, 2016 19:52
Show Gist options
  • Star 1 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save ParaplegicRacehorse/316f67d91124e95092a68340e2b6ac24 to your computer and use it in GitHub Desktop.
Save ParaplegicRacehorse/316f67d91124e95092a68340e2b6ac24 to your computer and use it in GitHub Desktop.
TODO for technical documentation and manual authoring [Plume Creator](https://github.com/jacquetc/plume-creator)

Create a Plume document inside the current version of Plume - the DEVEL release - and use it to orient a new user and showoff all the cool features; possibly even suggest a workflow.

  • Importing stuff
    • Old Plume files
    • Collections of text files
      • lightweight markup (Markdown, Textile, Restructured Text, Asciidoc, etc.)
      • heavyweight markup (HTML, DocBook, TeX/LaTeX, etc.)
    • .odt files
    • MS Word files (.doc, .docx)
    • reference documents, media
  • Exporting stuff
    • HTML
    • PDF
    • epub
    • Mobi and other Amazon formats
    • custom stylesheets
  • Linking to external media
    • citing sources
    • using BibTeX
  • Internal links
  • Mise en Scene
  • Character editor
  • Binder

...more I can't think of right now.

Procedural

  • Decide on authoring format. I'm partial to Asciidoc.
  • creat a docs/ directory in the project tree and populate it with a beginning

What to write

  • Front Matter

    This is the usual title-page, copyright, etc.

  • Introduction

    What is Plume, how to install it, etc.

etc. To be flushed out as a document skeleton is created.

This will pretty much have to written by @jacquetc and the coding team.

  • API reference, if any
  • doc.plume file type reference
  • code formatting standards
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment