rcv icon indicating copy to clipboard operation
rcv copied to clipboard

Research more sustainable documentation pipelines

Open yezr opened this issue 1 year ago • 0 comments

Currently we use one giant google doc to draft our TDP. Let's research some more sustainable ways to build documentation.

Must haves

  • Simple offline access for use in air gapped environment
  • Easily configure and provision multiple editors
  • Easily see edit history
  • Multiple “production” versions - for each RCTab version
  • Easily printable PDF for hard copy (election admins love a printed copy 🙃)
  • Navigation links within the document

Nice to Have

  • Documentation versioning linked to code versioning
  • One source of truth that can be pushed out to different documentation locations (in-app hints, TDP, User Guide)
  • On-the-fly configurable per audience
    • Depending on your vendor, remove unnecessary information about other vendors or unnecessary configuration options
    • STV vs IRV also filters configuration options
    • Election Admin vs. Certification Body

Options

yezr avatar Apr 22 '24 16:04 yezr