![[site community profile]](https://www.dreamwidth.org/img/comm_staff.png){kind=small}
Site schemes and docs
Feb. 27th, 2009 02:50 pm![[personal profile]](https://www.dreamwidth.org/img/silk/identity/user.png){kind=small}
rhoSince we're hoping to have multiple different site schemes at some point, possibly sooner rather than later (I was prompted to think of this by ![[staff profile]](https://www.dreamwidth.org/img/silk/identity/user_staff.png)
denise mentioning on IRC she was working on one), we need to make sure that all our documentation is site scheme agnostic. This means, for example that we can't say "go to the 'read' option on the top navigation bar and select 'syndicated feeds' from the dropdown menu" since in other schemes there won't be a top navigation bar in other schemes.
However, all the schemes are going to be using the same menu structure. I think that the long term plan is to split off the menu structure from the schemes, so the schemes just have to point to the menu structure and updating that will update all the schemes. Don't quote me on that though. From our perspective this means that we can say "select 'syndicated feeds' under the 'read' option of the site menu".
Also, if referencing pages like this, always be sure to give a direct link to the page as well. The idea being along the lines of "here's a link to the page for you now, and here's how you can find it next time you need it".
denise mentioning on IRC she was working on one), we need to make sure that all our documentation is site scheme agnostic. This means, for example that we can't say "go to the 'read' option on the top navigation bar and select 'syndicated feeds' from the dropdown menu" since in other schemes there won't be a top navigation bar in other schemes.However, all the schemes are going to be using the same menu structure. I think that the long term plan is to split off the menu structure from the schemes, so the schemes just have to point to the menu structure and updating that will update all the schemes. Don't quote me on that though. From our perspective this means that we can say "select 'syndicated feeds' under the 'read' option of the site menu".
Also, if referencing pages like this, always be sure to give a direct link to the page as well. The idea being along the lines of "here's a link to the page for you now, and here's how you can find it next time you need it".