My dream documentation app

Firstly, let me give you abit of a run down to why i think this little app would be great.
Ive been instructed to do the dreaded documentation for the system that my current employment company produced and owns.
Now your typical set of documents are a number of doc files scattered in a folder with some kind of structure, this structure of changes from project to project. Personally i think you can create a general set of documents according to the project size (obviously some docs/diagrams are not always needed). So here is my idea for an application that would generate your docs based on one large wiki style document.

Documentor (a penny for another name)
The application that makes documentation a cinch.
When all your notes and tad-bits are scattered, this application brings them all together
Combining wiki style document navigation and information cross-linking with version control, multi-user collaboration and format/template exporting

An application to store your thinking, thoughts, cerebration, intellection & other mentations.
Easily add ideas, images and any other kind of media you need to keep track of. No need to worry about documentation structure, leave the organising to this application. With advanced searching nothing will ever be forgotten - Never loose track of information with *incremental* searching. Highlight words or phrases and link them to pages, file your pages in a document category and generate documentation quickly and easily - Forget “documentation semantics”, this application allows for free flowing forward thinking.

So how does this relate to documentation, if documentations is based on a strict set of documents all with there purposed then how does this all fit together?… Well

Cross platform (Linux, Windows & Mac supported)

Basic features to achieve:

  • Version Control (WikiWord/Page History).
  • Wiki style markup (Wiki text styling).
  • Inline editing and On the fly (realtime) WikiWords linking (linking of pages).
  • Easy WikiWords navigation (Page navigation via WikiWords in normal view).
  • Tree/Outline view.
  • Wiki document attributes.
  • View modes (Edit & Normal)… Dynamic views in tabs
  • Incremental search.
  • Search and Replace.
  • Autosave.
  • All your data is stored in plain text.
  • URL and file linking.
  • Unicode, Rich Text support, and image embedding.
  • Web Sharing - Mini web app to share your pages with friends or co-workers on the internet without any pain.
  • Access control
  • Template exporting

And finally checkout the mockup

dream documentation app first mockup

Mad props & just dues

Syndicate

Activity

One comment, leave your comment or trackback.
  1. hehehe… I like it Stelio!

    Now as someone who has been responsible for forcing our MIS developers to firstly comment their code, then create not only release notes, but test on the test system first before the release… AND create documentation that explains how the coded the new code so that another developer can understand AND write user manuals… I love this.

    Why?

    ‘cos no developer I know actually documents properly! ;)


Leave a Reply


Search

The archives run deep. Feel free to search older content using topic keywords.