This project is to write a 10 page developer's guide, discussing
(a) overview of our product and how it helps developers,
(b) overall architecture,
(c) instructions for a simple customization,
(d) instructions for medium customization,
(e) a complex customization,
(f) overview of the API,
(g) detailed reference to XML files 1 and 2,
(h) tips for integrating with a CMS,
(i) various development ideas and tips,
(j) a conclusion.
Our software is a web-based navigational tool. The tool helps people find information with an innovative design, using radial maps, which allow users to easily browse hierarchies or networks of information. Any kind of information can be represented with interconnected "nodes." Broadly speaking, with our tool, users don't have to hack their way through a jungle of information to find what they seek. Instead, they can take a helicopter ride and view the entire landscape of a web site, then land in a clearing for detailed exploration.
We offer developers an easy way to add value to existing applications by adding complex visualizations, or a platform for them to create entirely new applications. Our technology is perfect for creating enticing, interactive sitemaps for CMS, visualizations of relationships between pieces of information, enhanced e-commerce experiences, and so much more.
Our product is in late development stages. It is customized by editing one of two XML files.
The software is working, and you will be able to experiment with it. Our XML settings files are defined. We seek clear documentation from a developer's point of view. The writing should be short and efficient.
We will provide you with our existing documentation, sample files, a spec for our XML file, and some introductory concepts. We will provide ongoing feedback. You will write the 10 pages.