I find that developer documentation is often not very pleasant to look at and, more importantly, often very difficult to navigate. I worked briefly with the PayPal REST API and, while I found that at times it can be confusing to deal with the numerous APIs PayPal offers, aesthetically their developer documentation is clear and effective.
What I Like
Clear Overall Design
Overall the documentation looks nice and clear. I like the fonts and colours used. The multi-level menu on the left fits in well and provides good means of navigation without feeling overwhelming.
Good Instructions and Code Examples
The subheadings are easy to spot and the step-by-step instructions weave code into them quite nicely. Code examples stand out due to the different background colour.
Clear and Informative Footer
The footer for the page fits nicely into the overall design and gives access to a wide range of resources.
After I had recently completed a first version of interactive showcases for the Appjangle platform, it was now about time to give a little rework to the homepage. Arguably, it was a bit dull and, more importantly, not very informative – in particular in regards to giving an overview of what Appjangle is good for and what it does.
This is how the last version of the homepage looked like:
The redesign, accomplished in 350 min (yes, I am slow and I also love to measure time), focused on the following objectives:
- Allow to understand what the Appjangle platform does.
- Provide an overview of the benefits of the platform.
- Give a clear indication of what a visitor can do next.
Well, this is how the new page looks like:
I believe that this new design meets the described objectives much better than the old version. However, there are still plenty of steps which stand between this version and ‘perfect’.
Now, I am certainly not what I would call a naturally gifted graphics artist. However, I think it’s often a diversion from my usual occupations of writing code and writing academically to move around some pixels. Also, it’s nice to see a design develop over time. Actually I started working on this ‘entry page’ in November 2011 – at that time Appjangle was still called ‘Nx Framework’, and the Introduction was somewhat wordy: Nx Framework Introduction.
Anyway, next on my list are the sign up screen and the hosting options– when my thesis will grant me some time.
This post is also published on the Appjangle Blog.