Jump to content

Improved documentation


blartyo

Recommended Posts

Posted
Yardman and all,

 

I would like discussing the origination of the Wiki. Yardman and others in the past expressed it was too confusing and wanted to change it, so I would like to get some ideas. When the ideas are finalized I don't mind spending the time reorganizing it for all. Might I suggest that we discuss in outline format like below which would make the implementation much easier later. Michel I want your feedback too, after all you’re the top guy.

 

Main

__ Products

_____ ISY-26

_____ ISY-99i

__ Support Section

_____ Troubleshooting

_____ Known Issues

__ etc.

 

First, I would think the '-- In Beta' note could be removed, now that the 99i Series has been released :wink: .

 

The information on the 'ISY-26 Insteon' page and 'ISY-99i Series' page is the same, for the most part. While the Firmware is different, the link on the two pages is the same. Even the Release Notes, while originally different, are now merging into one stream. The differences on the 99i page seem to be the 99i-specific documentation, and the References section which does not appear on the 26 page.

 

On the other hand, much of the content of these pages is what I would consider 'top-level', i.e. information the user wants to reach quickly when looking for help, such as documentation, How-Tos and Logon to My Insteon ISY Now, among others. We may be well served by placing this information on the front page.

 

On still another hand, I do understand that we don't want to make the front page too long, so we don't want to place everything there. While the Downloads, Firmware, and Release Notes sections are common, perhaps they could be left on the individual product pages, or they could be grouped on another page linked from the front page. The individual product pages could be left to host product information such as features, specifications, and so forth.

 

That leaves the Documentation and Resources sections to be moved to the front page. I think they would fit well in your proposed structure between Products and Support, something like:

 

Main

__ Products

_____ ISY-26

_____ ISY-99i

__ Documentation

_____ Quick Start Guide

_____ User Guide

_____ How-To Guide

_____ etc.

__ Resources

_____ Logon to My Insteon ISY Now!

_____ etc.

__ Support Section

_____ Troubleshooting

_____ Known Issues

__ etc.

 

Possibly even the 99i documentation could be merged with the main documentation, giving each section a note in its title, such as Quick IR Tutorial (ISY-99i only).

 

Just some thoughts :D .

Posted

Good stuff Darrell!

 

My question is how many future products will have this merged functionality?

 

Will they always be grouped by the first part of the ISY name?

 

Because then we could have a second level section that is just for the ISY units. I think as the UDI products grow this Wiki will serve them all so putting things that are for the ISY series on the first page may not be future proof.

 

Main

__ Products

_____ ISY-26

_____ ISY-99i

__ ISY Controller Series Resources

_____ Logon to My Insteon ISY Now!

_____ Documentation

________ Quick Start Guide

________ User Guide

________ How-To Guide

________ etc.

_____ Support Section

________ Troubleshooting

________ Known Issues

__ UDI Devices Resources

_____ etc.

__ Global Support

_____ Contact Info

 

...

Posted

Point well taken, Mark. The documentation and resources for the ISY-UPB and ISY-ZWAVE are likely to be different than those for the INSTEON series! It is just the 26 and 99i which share a common base.

Archived

This topic is now archived and is closed to further replies.

×
×
  • Create New...