WattDepot docs progress du jour

8 views
Skip to first unread message

Philip Johnson

unread,
Dec 7, 2013, 8:26:32 PM12/7/13
to wattdep...@googlegroups.com
OK, I just put another few hours of work into the documentation.  Go to:


You might need to refresh your browser to see the look and feel changes.  The WattDepot logo now is in the navbar, and there's a new "Overview" section. 

I've also revised the set of milestones to more clearly indicate the deliverable associated with their completion:


The one I've worked on a bunch today is the deployment of version 3 of wattdepot.org:


In other words, my current thinking is that the viewdocs site should become the new home of wattdepot.org, and I've been working on it today with that goal in mind.  I think the current structure provides a good way for a newcomer to WattDepot to get familiar with the system. Of course, many rough edges remain and please don't hesitate to suggest (or just go ahead and implement) improvements. 

There are 17 open issues associated with this particular milestone, most of which involve the editing of a markdown file.  I've distributed this work between Cam, Yongwen, and Robert. My thinking is that in some cases, it's better for Cam to not document a particular feature, but rather to have someone else do it with "fresh eyes" (which might require a conversation with Cam to learn what needs to be documented).  I also didn't want to stick Cam with all of the documentation work.  I didn't assign any to me, because I've already written a bunch of pages and I want to reserve my effort for post-production editing. 

While this is a fair number of issues, the good news is that in many cases the contents of the markdown file is not extensive: it's basically a single section of a larger guide.  My hope is that most of them will take well under an hour to write. In some cases, they might surface the need for additional development, which is cool.

I've also tasked Robert with switching wattdepot.org to http://wattdepot.viewdocs.io/wattdepot.  I don't think this needs to wait to be the last thing on the list; I think the site is already much more useful to visitors than the google docs site. But as long as it gets done before the milestone is due it doesn't matter to me. 

Let me know if you see any problems with any of this, or opportunities for improvement. I just realized that it would be cool to provide a footer, I'll work on that in the near future.   

Reply all
Reply to author
Forward
0 new messages