SitePoint Sponsor

User Tag List

Results 1 to 6 of 6
  1. #1
    SitePoint Member runnermx's Avatar
    Join Date
    Oct 2003
    Location
    Ontario
    Posts
    11
    Mentioned
    0 Post(s)
    Tagged
    0 Thread(s)

    Question Web Project Documentation

    Hello everybody,

    I'm just finishing a client's website in order to complete this project I have to deliver a kind of "documentation", basically this websiste have some Flash movies and HTML documents, not database or scripts.
    I had some ideas to do this, I started with a description of the layout (basically dimensions in the design process), colors and fonts that i used as well a brief description of folders and files location.

    Does anyone have another suggestions to make a "professional" documentation.

    Thnak you in advance!

  2. #2
    SitePoint Zealot
    Join Date
    Oct 2003
    Location
    USA
    Posts
    173
    Mentioned
    0 Post(s)
    Tagged
    0 Thread(s)
    .
    2 | 3 | 4 | 5 | 6 | 7 | 8 | 9
    2 | 3 | 4 | 5 | 6 | 7 | 8 | 9
    2 | 3 | 4 | 5 | 6 | 7 | 8 | 9

  3. #3
    SitePoint Wizard silver trophy
    beley's Avatar
    Join Date
    May 2001
    Location
    LaGrange, Georgia
    Posts
    6,117
    Mentioned
    3 Post(s)
    Tagged
    0 Thread(s)
    I always document the style... i.e. styles, fonts, colors, other typography elements, etc. I also document standards... i.e. page is centered, text starts 20 pixels from the left or there is always a 10 pixel border/padding. You get the picture. That way if anyone works on the site except you they will have a good idea of what to change, and what they should't change.

  4. #4
    chown linux:users\ /world Hartmann's Avatar
    Join Date
    Aug 2000
    Location
    Houston, TX, USA
    Posts
    6,455
    Mentioned
    11 Post(s)
    Tagged
    0 Thread(s)
    Yep, I have to agree with Brandon. Make the documentation an overview of how the site is layed out and the methods you used to create it (CSS, tables, etc.)

    Layout the styles you used, what fonts, where you got certain buttons, graphics, etc. (if you created them yourself, make a note of it)

  5. #5
    SitePoint Member runnermx's Avatar
    Join Date
    Oct 2003
    Location
    Ontario
    Posts
    11
    Mentioned
    0 Post(s)
    Tagged
    0 Thread(s)
    Thank you guys for your suggestions I'll put those ideas in my document!!!.

    Cheers!.

  6. #6
    eCommerce specialist hotnuts21's Avatar
    Join Date
    Apr 2002
    Location
    Aberystwyth, UK
    Posts
    1,355
    Mentioned
    0 Post(s)
    Tagged
    0 Thread(s)
    I usually bung a copy of the site on CD and provide this with any documentation, so they always have a copy available.
    Search & Rescue Aberystwyth Lifeboat
    CSS Tutorials/Guides

    Sitepoint signatures are not visible to Search Engines More info


Bookmarks

Posting Permissions

  • You may not post new threads
  • You may not post replies
  • You may not post attachments
  • You may not edit your posts
  •