Reply to Re: how to document a website/database

Your name:

Reply:


Posted by Shawn Wilson on 03/01/06 20:42

NC wrote:

> Consider creating three documents:
>
> 1. Functional specification -- a document explaining what your
> application is supposed to do.
>
> Read "Painless Functional Specifications" by Joel Spolsky:
>
> http://www.joelonsoftware.com/articles/fog0000000036.html
> http://www.joelonsoftware.com/articles/fog0000000035.html
> http://www.joelonsoftware.com/articles/fog0000000034.html
> http://www.joelonsoftware.com/articles/fog0000000033.html
>
> (Yes, in that order...)
>
> 2. User's manual -- a document explaining how a user is supposed
> to get the application to do what it's supposed to do.
>
> You may want take a look at "User Interface Design for Programmers"
> by Joel Spolsky:
>
> http://www.joelonsoftware.com/uibook/chapters/fog0000000057.html
> http://www.joelonsoftware.com/uibook/chapters/fog0000000058.html
> http://www.joelonsoftware.com/uibook/chapters/fog0000000059.html
> http://www.joelonsoftware.com/uibook/chapters/fog0000000060.html
> http://www.joelonsoftware.com/uibook/chapters/fog0000000061.html
> http://www.joelonsoftware.com/uibook/chapters/fog0000000062.html
> http://www.joelonsoftware.com/uibook/chapters/fog0000000063.html
> http://www.joelonsoftware.com/uibook/chapters/fog0000000064.html
> http://www.joelonsoftware.com/uibook/chapters/fog0000000065.html
>
> 3. Developer's manual -- a document explaining what the application's
> architecture is, what different pieces of code do, and what the
> application's data model is (e.g., what the database tables are used
>
> for and what the fields in those tables store).

I just read half of the first one. It appears to be pretty well written.
I'll give those a read.

Thanks,
Shawn

[Back to original message]


Удаленная работа для программистов  •  Как заработать на Google AdSense  •  England, UK  •  статьи на английском  •  PHP MySQL CMS Apache Oscommerce  •  Online Business Knowledge Base  •  DVD MP3 AVI MP4 players codecs conversion help
Home  •  Search  •  Site Map  •  Set as Homepage  •  Add to Favourites

Copyright © 2005-2006 Powered by Custom PHP Programming

Сайт изготовлен в Студии Валентина Петручека
изготовление и поддержка веб-сайтов, разработка программного обеспечения, поисковая оптимизация