How do you write a Project Maintenance Tips document?
The following are checklists to follow when modifying a project. Use these checklists as a starting point and modify them as needed for your own projects. These checklists are used to ensure your projects remain consistent, unbroken and user friendly as they are changed over time.
Adding a new page:
Start with appropriate index or content page as a template to ensure page is consistent in layout and design with other pages. Add content to middle table abiding by design guidelines, keeping the sites header and trailer navigation consistent. Update keyword list library for search engines and meta tags.
Update page description meta tag. Update page title meta tag. Update revision date.
Modify index and content pages to link the new page (see modifying below). Update site map. Run spell checker.
If needed copy text into word processor for grammar checking. Upload all related page changes, graphics and components. Test page modifications (see below).
Consider using a tool such as link consistency checker to recheck all of the sites links. Add page to WebPosition or Search Engine Commando Pro submission process to be submitted to search engines (or add to robots.txt file if new pages is not to be spidered). If a form or script was added test all functions and all possible combinations of inputs.
Modifying a page:
Check out the page to be modified if using a source code control system (i.e. don’t modify a page if someone else has control over it, otherwise changes may be overwritten and lost). Make modifications abiding by established design guidelines to keep the design consistent. Update the home page new section for important additions.
Run spell checker and/or grammar checker. Update revision date. Upload all related page changes, graphics and components. Test page modifications (see below).
If adding a form or script test all new and existing functionality.
Deleting a Page:
Web pages should never be deleted. Change them to redirect to another page. They may be bookmarked or indexed by external sites.
If you do delete pages your web server should be configured to display a custom error page that is integrated with the sites look and feel. Intranet pages may be deleted. Notify web master, as links may be broken.
Upload all related page changes, graphics and components. Test page modifications (see below). Test site with a link consistency checker to check for broken links after removing page from server.
Test with latest versions of appropriate browsers. Test all plug-ins and applets. Test all forms and scripts.