View Single Post
Old 06-30-2008, 11:25 PM  
brandonstills
Confirmed User
 
brandonstills's Avatar
 
Join Date: Dec 2007
Location: Chatsworth, CA
Posts: 1,964
Important rules for designers/coders to make people want to hire and recommend you

As a programmer I frequently have designers deliver files to me or I take over projects from a webmaster long gone. I frequently run into similar situations in which designers and coders don't consider how their work will be used further down the line and it causes work to take much longer than it should for future people.

When working in a team environment (or just in general) please keep the following things in mind. They are the difference between a project taking a few days and taking weeks and even months. Following them is the difference between having coworkers recommend you for a project because you are a joy to work with and them asking if someone else can be hired.

1) If the files will need to have code added to them and will eventually be called *.php don't name them *.html. Coders will have to rename EVERY file and update EVERY link on EVERY page and repeat the process EVERY time the designer gives him something new when the code has already been integrated. Name them *.php to begin with.

2) If there is a header and footer that will be the same on every page, put them in a file called header.php / footer.php and include it. Don't repeat the same thing on every single page. If there are changes that need to be made someone is going to have to go through and update 30 pages just to make 1 change. If there is a change made by the designer and the code needs to be reincorporated the programmer has to repeat the whole process again. Something that should take a few hours now takes days.

Copy and paste the common bit into a file, e.g., header.php.

Then instead of repeating the same HTML you can now use <?php include 'header.php'; ?>

That's it, just one line.

I believe Dreamweaver has a template feature that lets you change it once on your end, but please be considerate to people further down the line and people taking over the project later on.

If you need to be able to execute php code locally look into something like XAMPP. It's easy to install.

3) Whenever possible, use relative paths and avoid the trailing '/' at the beginning of an HREF or SRC attribute. Sometimes domains change, they get moved to sub domains, or have to be moved to another directory. Don't use <img src="http://www.thedomain.com/images/theImage.jpg"> use <img src="images/theImage.jpg">. Notice there is no trailing '/' in front of images.

4) Use CSS whenever possible, especially for layout (as opposed to tables). Having to modify things nested 5 tables deep is extremely confusing, time consuming and prone to errors.

5) Make sure your HTML is valid. Run it through a validator tool. I've seen pages where there are opening tags (table, tr, td, div) but no closing tags. It's near impossible to modify the more complex pages without spending hours to make a simple change or throwing everything away and completely rewriting it.

6) I'm surprised I even have to mention this one. If you are using some kind of hierarchy, don't copy the same exact files into every single sub folder. E.g., if each model has a sub folder with an .html page in it, don't copy the nav-banner.jpg into every single sub folder. There should only be 1 nav-banner.jpg on the server, not 1 for each sub folder. Have the HTML use a relative path to refer to it.

7) Deliver the final .PSD files to the owner even if they don't know what to do with them or don't ask for them. Explain what they are for and why they should hold on to them. They may hire someone later down the road and if changes need to be made they basically have to redo the entire site.

8) If the owner is non-technical and you are doing a lot of the server administration give him a summary detailing his login information and where you put things. Don't assume since he forwarded you an email from the host he understands it. Having it summarized will make it much easier for them and will prevent delays in him giving that information to future people.

9) If there are other people working on the project get in contact with them and ask them how they like things delivered and if they like things done in a certain way. This is especially true if the owner doesn't really know the terminology the different people are using. Things get lost in translation and frustrations happen further down the line when things don't get properly communicated and they aren't what someone expected.

10) If you know multiple people are working on different parts and will probably use the same folder names (e.g., 'images') or things will end up in the same folder make yours unique. If your company is called My Design Company use 'MDC_images' or maybe 'MDC/images' instead of 'images'. If it's for a tour use 'tour_images' or put all your stuff into a sub directory called 'tour'.

11) Keep design images stored in a different folder than demo content images. E.g., if the owner gives you some photos to use on the tour and you know he will change them out later on don't co-mingle them with the design images, put them in a separate folder. This is especially important if images might be named the same as some of your design images.

I'm sure there are many other things, these are just a few of them I have run across. If anyone else has further recommendations I'm sure we'd all love to hear them.
brandonstills is offline   Share thread on Digg Share thread on Twitter Share thread on Reddit Share thread on Facebook Reply With Quote