Last Updated: 27 Jun 2023
|
Differences
This shows you the differences between two versions of the page.
Next revision | Previous revision Last revision Both sides next revision | ||
processes:documentation-practical-practices-and-ideas [Jun 17, 2009 06:11 AM] dordal created |
processes:documentation-practical-practices-and-ideas [Jun 24, 2023 09:23 AM] 111.225.149.169 removed |
||
---|---|---|---|
Line 1: | Line 1: | ||
+ | = Documentation - Practical Practices & Ideas = | ||
+ | |||
+ | This document aims to give some practical ideas and advice for Internet startups and Internet development shops as to what they should consider documenting when they' | ||
+ | |||
+ | Generally speaking, I like to keep written documentation simple. Most documentation should be inline in your code or configuration files... for example, instead of documenting every apache configuration setting you have used, just say somewhere "we use apache; more documentation is in the config file at ''/ | ||
+ | |||
+ | I find it easiest to keep all of this documentation on a wiki accessible to everyone. | ||
+ | |||
+ | == Web App Development - Specific App == | ||
+ | |||
+ | * Statement of Work / [[: | ||
+ | * [[: | ||
+ | * [[: | ||
+ | * Database Schema (may just be SQL, or may be a visual model) | ||
+ | |||
+ | == Website Development - Specific Site == | ||
+ | |||
+ | * Statement of Work | ||
+ | * Creative Brief | ||
+ | * Site Design Wireframes | ||
+ | * Competitive Sites Brief | ||
+ | |||
+ | == Infrastructure == | ||
+ | |||
+ | * Code/ | ||
+ | * Network Infrastructure Map - Physical & Virtual (if appropriate) | ||
+ | * [[: | ||
+ | * [[: | ||
+ | * Naming Conventions | ||
+ | |||
+ | == Web App Development - General == | ||
+ | |||
+ | * [[: | ||
+ | * Naming Conventions | ||
+ | |||
+ | == Technical How-To == | ||
+ | |||
+ | * Step-By-Step for any common procedures | ||
+ | |||
+ | == Customers == | ||
+ | |||
+ | * Standardized Customer Service Procedures | ||
+ | |||
+ | == Development == | ||
+ | |||
+ | * [[: | ||
+ | * [[: | ||
+ | |||
+ | == APIs / External Data Sources == | ||
+ | |||
+ | * Data Formats | ||
+ | * API Calls | ||
+ | |||
+ | == Operations == | ||
+ | |||
+ | * Key Contacts - All Vendors + Internal Contact Person | ||
+ | * Disaster Mitigation Plans - Specific How Tos & To Do Lists for Disaster Scenarios | ||
+ | |||
+ | == Fun == | ||
+ | |||
+ | * [[: | ||
+ | |||