• DocumentCode
    3680963
  • Title

    Automated user documentation system for Android

  • Author

    Florin B. Manolache;Yifan Li;Octavian Rusu

  • Author_Institution
    Carnegie Mellon University Pittsburgh, Pennsylvania, USA
  • fYear
    2015
  • Firstpage
    63
  • Lastpage
    67
  • Abstract
    Documenting android projects and synchronizing the help pages with the current stage of the project is a time consuming task, especially for complex projects developed by larger teams. Keeping the website of the project synchronized with the current development is even more difficult, since usually the two components are maintained by different people or teams. This paper proposes an automated documentation system based on a wiki that is filled by contributors, and a software system that extracts the info from the wiki and builds a set of html help pages that are incorporated automatically in the project with every new version. The documentation system is not project specific, and offers the following advantages over maintaining the help pages by hand: the help system automatically reflects the current content of the wiki; the help system of the app is independent of the network; every version of the software keeps a set of help pages specific to the development stage of that version. The implementation uses python and is available as open source.
  • Keywords
    "Decision support systems","Radio frequency","Uniform resource locators","Browsers"
  • Publisher
    ieee
  • Conference_Titel
    RoEduNet International Conference - Networking in Education and Research (RoEduNet NER), 2015 14th
  • ISSN
    2068-1038
  • Print_ISBN
    978-1-4673-8179-6
  • Electronic_ISBN
    2247-5443
  • Type

    conf

  • DOI
    10.1109/RoEduNet.2015.7311829
  • Filename
    7311829