Re: [WSG] Website Creation Documentation Standards
Apologies Lorrie, I'm not sure this will help, but I try to include a Design Notes page at the end of a tutorial. This supplies some metadata about the construction of the web docs (structure, presentation, and behavior layers) which make up the tutorial. Users are free to use it whatever way they wish. Here's an example: http://frank.helpware.net/cshelp/DesignNotes.htm Med vennlig hilsen / Kind regards, Frank M. Palinkas Technical Writer, Opera Software http://dev.opera.com/articles/accessibility/ On Sat, May 2, 2009 at 2:52 PM, Lorrie Laskey lrmal...@bellsouth.netwrote: Frank, The content of your message did not show up, only your closing and signature. Lorrie Frank Palinkas wrote: Med vennlig hilsen / Kind regards, Frank M. Palinkas Technical Writer, Opera Software http://dev.opera.com/articles/accessibility/ On Fri, May 1, 2009 at 6:38 PM, Lorrie Laskey lrmal...@bellsouth.netmailto: lrmal...@bellsouth.net wrote: List, I am a web designer as a hobby and have run into a situation where I am not sure where to search. Does a standard exist for the creation of web site creation documentation? By this I mean documentation that would/might be turned over to the end user: 1. to allow the end user to mange the site himself 2. to document the project and for future reference Having created a few sites I have been trying on my own to determine what information should be documented and in what format and by what specs. I hope this makes sense. If they do exist, would someone point me to them and some examples as well as any software, open source if possible, that exists. If not, are there any industry general practices that I can read? One last question, if such standard exist are they working with the W3C community and where might that info be, please? Lorrie *** List Guidelines: http://webstandardsgroup.org/mail/guidelines.cfm Unsubscribe: http://webstandardsgroup.org/join/unsubscribe.cfm Help: memberh...@webstandardsgroup.org mailto:memberh...@webstandardsgroup.org *** *** List Guidelines: http://webstandardsgroup.org/mail/guidelines.cfm Unsubscribe: http://webstandardsgroup.org/join/unsubscribe.cfm Help: memberh...@webstandardsgroup.org *** *** List Guidelines: http://webstandardsgroup.org/mail/guidelines.cfm Unsubscribe: http://webstandardsgroup.org/join/unsubscribe.cfm Help: memberh...@webstandardsgroup.org *** *** List Guidelines: http://webstandardsgroup.org/mail/guidelines.cfm Unsubscribe: http://webstandardsgroup.org/join/unsubscribe.cfm Help: memberh...@webstandardsgroup.org ***
Re: [WSG] Website Creation Documentation Standards
Hi Lorrie, When I read your email, it seemed to me you were referring to what I've read in web design books called 'deliverables'. A concept I think inherited from print and graphic design. For instance I recently bought a copy of Elliot Jay Stocks Sexy Web Design from Sitepoint ( http://www.sitepoint.com/books/ ) and last chapter speaks of this. However, beyond being called a style guide, I don't discern a common set of rules such that there exists software to assist you explicitly with a style guide. Another Sitepoint book from a few years back by Shirley Kaiser Deliver First Class Web Sites ( http://www.sitepoint.com/books/checklists1/?SID=3598de07047196325426cba641ee236c ) in the third chapter refers to a technique called content inventory which whilst different to a style guide, could class as a handover document. She refers to an excellent article by Jeffrey Veen on the subject which might assist - http://www.adaptivepath.com/ideas/essays/archives/40.php Finally in somewhat the same vein as Franks answer and using a similar technique, a presentation from a Natalie Downe of Clearleft in England on Maintainable CSS. At the end of the presentation she appears to create a HTML document that allows any future front end developer to quickly understand the styles and patterns in a technical sense. So whilst useful for a developer, probably of little consequence to a website owner. See the presentation here - http://natbat.net/ In the end, presuming I was in the ball park when I assumed you meant deliverables, as best as I can tell there is only techniques that work for you, rather than a standard such that the W3C would endorse. Hope some of this is helpful. John Unsworth List, I am a web designer as a hobby and have run into a situation where I am not sure where to search. Does a standard exist for the creation of web site creation documentation? By this I mean documentation that would/might be turned over to the end user: 1. to allow the end user to mange the site himself 2. to document the project and for future reference Having created a few sites I have been trying on my own to determine what information should be documented and in what format and by what specs. I hope this makes sense. If they do exist, would someone point me to them and some examples as well as any software, open source if possible, that exists. If not, are there any industry general practices that I can read? One last question, if such standard exist are they working with the W3C community and where might that info be, please? Lorrie *** List Guidelines: http://webstandardsgroup.org/mail/guidelines.cfm Unsubscribe: http://webstandardsgroup.org/join/unsubscribe.cfm Help: memberh...@webstandardsgroup.org ***
Re: [WSG] Website Creation Documentation Standards
John, Yes you were in the ballpark. Not being a professional I did not know what to ask for but I learned a new term, deliverables. I look forward to checking out the links you gave me. Thanks for answering my question regarding W3C standards. Lorrie *** John Unsworth wrote: Hi Lorrie, When I read your email, it seemed to me you were referring to what I've read in web design books called 'deliverables'. A concept I think inherited from print and graphic design. For instance I recently bought a copy of Elliot Jay Stocks Sexy Web Design from Sitepoint ( http://www.sitepoint.com/books/ ) and last chapter speaks of this. However, beyond being called a style guide, I don't discern a common set of rules such that there exists software to assist you explicitly with a style guide. Another Sitepoint book from a few years back by Shirley Kaiser Deliver First Class Web Sites ( http://www.sitepoint.com/books/checklists1/?SID=3598de07047196325426cba641ee236c ) in the third chapter refers to a technique called content inventory which whilst different to a style guide, could class as a handover document. She refers to an excellent article by Jeffrey Veen on the subject which might assist - http://www.adaptivepath.com/ideas/essays/archives/40.php Finally in somewhat the same vein as Franks answer and using a similar technique, a presentation from a Natalie Downe of Clearleft in England on Maintainable CSS. At the end of the presentation she appears to create a HTML document that allows any future front end developer to quickly understand the styles and patterns in a technical sense. So whilst useful for a developer, probably of little consequence to a website owner. See the presentation here - http://natbat.net/ In the end, presuming I was in the ball park when I assumed you meant deliverables, as best as I can tell there is only techniques that work for you, rather than a standard such that the W3C would endorse. Hope some of this is helpful. John Unsworth List, I am a web designer as a hobby and have run into a situation where I am not sure where to search. Does a standard exist for the creation of web site creation documentation? By this I mean documentation that would/might be turned over to the end user: 1. to allow the end user to mange the site himself 2. to document the project and for future reference Having created a few sites I have been trying on my own to determine what information should be documented and in what format and by what specs. I hope this makes sense. If they do exist, would someone point me to them and some examples as well as any software, open source if possible, that exists. If not, are there any industry general practices that I can read? One last question, if such standard exist are they working with the W3C community and where might that info be, please? Lorrie *** List Guidelines: http://webstandardsgroup.org/mail/guidelines.cfm Unsubscribe: http://webstandardsgroup.org/join/unsubscribe.cfm Help: memberh...@webstandardsgroup.org *** *** List Guidelines: http://webstandardsgroup.org/mail/guidelines.cfm Unsubscribe: http://webstandardsgroup.org/join/unsubscribe.cfm Help: memberh...@webstandardsgroup.org ***
Re: [WSG] Website Creation Documentation Standards
Hi Lorrie, List, I am a web designer as a hobby and have run into a situation where I am not sure where to search. Does a standard exist for the creation of web site creation documentation? By this I mean documentation that would/might be turned over to the end user: 1. to allow the end user to mange the site himself 2. to document the project and for future reference When you ask about documentation to allow the end user to mange the site himself you're not very clear about whether you mean documenting the construction of the site, e.g., the setup of the CSS for developing future pages, or actual use, e.g., adding/updating/deleting content via a CMS. I don't have any suggestions for the former but for the latter I can recommend Screensteps. It's not open source but it is fast: http://www.bluemangolearning.com/ Cheers, Nick *** List Guidelines: http://webstandardsgroup.org/mail/guidelines.cfm Unsubscribe: http://webstandardsgroup.org/join/unsubscribe.cfm Help: memberh...@webstandardsgroup.org ***
Re: [WSG] Website Creation Documentation Standards
Nick, I apologize for being unclear. It is very hard to put into words ideas that one knows little about. I will do some more checking and clarify exactly what I am looking for before posting again. Thanks for responding and letting me know of the problem. I wondered why I did not get any responses and I will check out Screensteps. Thanks for the tip. It is a start. Lorrie ** Nick Lo wrote: Hi Lorrie, List, I am a web designer as a hobby and have run into a situation where I am not sure where to search. Does a standard exist for the creation of web site creation documentation? By this I mean documentation that would/might be turned over to the end user: 1. to allow the end user to mange the site himself 2. to document the project and for future reference When you ask about documentation to allow the end user to mange the site himself you're not very clear about whether you mean documenting the construction of the site, e.g., the setup of the CSS for developing future pages, or actual use, e.g., adding/updating/deleting content via a CMS. I don't have any suggestions for the former but for the latter I can recommend Screensteps. It's not open source but it is fast: http://www.bluemangolearning.com/ Cheers, Nick *** List Guidelines: http://webstandardsgroup.org/mail/guidelines.cfm Unsubscribe: http://webstandardsgroup.org/join/unsubscribe.cfm Help: memberh...@webstandardsgroup.org *** *** List Guidelines: http://webstandardsgroup.org/mail/guidelines.cfm Unsubscribe: http://webstandardsgroup.org/join/unsubscribe.cfm Help: memberh...@webstandardsgroup.org ***
Re: [WSG] Website Creation Documentation Standards
Med vennlig hilsen / Kind regards, Frank M. Palinkas Technical Writer, Opera Software http://dev.opera.com/articles/accessibility/ On Fri, May 1, 2009 at 6:38 PM, Lorrie Laskey lrmal...@bellsouth.netwrote: List, I am a web designer as a hobby and have run into a situation where I am not sure where to search. Does a standard exist for the creation of web site creation documentation? By this I mean documentation that would/might be turned over to the end user: 1. to allow the end user to mange the site himself 2. to document the project and for future reference Having created a few sites I have been trying on my own to determine what information should be documented and in what format and by what specs. I hope this makes sense. If they do exist, would someone point me to them and some examples as well as any software, open source if possible, that exists. If not, are there any industry general practices that I can read? One last question, if such standard exist are they working with the W3C community and where might that info be, please? Lorrie *** List Guidelines: http://webstandardsgroup.org/mail/guidelines.cfm Unsubscribe: http://webstandardsgroup.org/join/unsubscribe.cfm Help: memberh...@webstandardsgroup.org *** *** List Guidelines: http://webstandardsgroup.org/mail/guidelines.cfm Unsubscribe: http://webstandardsgroup.org/join/unsubscribe.cfm Help: memberh...@webstandardsgroup.org ***
Re: [WSG] Website Creation Documentation Standards
Med vennlig hilsen / Kind regards, Frank M. Palinkas Technical Writer, Opera Software http://dev.opera.com/articles/accessibility/ On Fri, May 1, 2009 at 6:38 PM, Lorrie Laskey lrmal...@bellsouth.netwrote: List, I am a web designer as a hobby and have run into a situation where I am not sure where to search. Does a standard exist for the creation of web site creation documentation? By this I mean documentation that would/might be turned over to the end user: 1. to allow the end user to mange the site himself 2. to document the project and for future reference Having created a few sites I have been trying on my own to determine what information should be documented and in what format and by what specs. I hope this makes sense. If they do exist, would someone point me to them and some examples as well as any software, open source if possible, that exists. If not, are there any industry general practices that I can read? One last question, if such standard exist are they working with the W3C community and where might that info be, please? Lorrie *** List Guidelines: http://webstandardsgroup.org/mail/guidelines.cfm Unsubscribe: http://webstandardsgroup.org/join/unsubscribe.cfm Help: memberh...@webstandardsgroup.org *** *** List Guidelines: http://webstandardsgroup.org/mail/guidelines.cfm Unsubscribe: http://webstandardsgroup.org/join/unsubscribe.cfm Help: memberh...@webstandardsgroup.org ***
Re: [WSG] Website Creation Documentation Standards
Frank, The content of your message did not show up, only your closing and signature. Lorrie Frank Palinkas wrote: Med vennlig hilsen / Kind regards, Frank M. Palinkas Technical Writer, Opera Software http://dev.opera.com/articles/accessibility/ On Fri, May 1, 2009 at 6:38 PM, Lorrie Laskey lrmal...@bellsouth.net mailto:lrmal...@bellsouth.net wrote: List, I am a web designer as a hobby and have run into a situation where I am not sure where to search. Does a standard exist for the creation of web site creation documentation? By this I mean documentation that would/might be turned over to the end user: 1. to allow the end user to mange the site himself 2. to document the project and for future reference Having created a few sites I have been trying on my own to determine what information should be documented and in what format and by what specs. I hope this makes sense. If they do exist, would someone point me to them and some examples as well as any software, open source if possible, that exists. If not, are there any industry general practices that I can read? One last question, if such standard exist are they working with the W3C community and where might that info be, please? Lorrie *** List Guidelines: http://webstandardsgroup.org/mail/guidelines.cfm Unsubscribe: http://webstandardsgroup.org/join/unsubscribe.cfm Help: memberh...@webstandardsgroup.org mailto:memberh...@webstandardsgroup.org *** *** List Guidelines: http://webstandardsgroup.org/mail/guidelines.cfm Unsubscribe: http://webstandardsgroup.org/join/unsubscribe.cfm Help: memberh...@webstandardsgroup.org *** *** List Guidelines: http://webstandardsgroup.org/mail/guidelines.cfm Unsubscribe: http://webstandardsgroup.org/join/unsubscribe.cfm Help: memberh...@webstandardsgroup.org ***
[WSG] Website Creation Documentation Standards
List, I am a web designer as a hobby and have run into a situation where I am not sure where to search. Does a standard exist for the creation of web site creation documentation? By this I mean documentation that would/might be turned over to the end user: 1. to allow the end user to mange the site himself 2. to document the project and for future reference Having created a few sites I have been trying on my own to determine what information should be documented and in what format and by what specs. I hope this makes sense. If they do exist, would someone point me to them and some examples as well as any software, open source if possible, that exists. If not, are there any industry general practices that I can read? One last question, if such standard exist are they working with the W3C community and where might that info be, please? Lorrie *** List Guidelines: http://webstandardsgroup.org/mail/guidelines.cfm Unsubscribe: http://webstandardsgroup.org/join/unsubscribe.cfm Help: memberh...@webstandardsgroup.org ***
