Project Documentation
It is required that all projects have project documentation which will outline all the projects details and credentials for the application and development.
The below is a base template for our project documentation, but should be extended to align with any bespoke or project related functionality.
Project Documentation
We Jump Higher - https://www.wejumphigher.co.uk
Project Name:
Project Domain:
Project Staging Domain:
Project Shared Mailbox:
Domain(s) Details / DNS:
Please provide details for the domain hosting and where to manage the domains DNS settings.
Domain Hosted:
Domain DNS:
Primary Contact
Hosting & Server Credentials
Details of the current server specifications, server requirements (PHP versions etc) and credentials to gain full access to production, staging and database servers.
Details regarding the current server structure, firewall settings etc.
Details regarding server SSL certifications / requirements. Process of renewing SSL’s.
Please document the current server infrastructure and setup?
Do the servers require custom configuration or settings? Please detail:
Production Server Specifications:
Production Server Access Credentials:
Production Server SSL Details:
Staging Server Specifications:
Staging Server Access Credentials:
Staging Server SSL Details:
Database Server Specifications:
Database Server Access Credentials:
SSL Renewal Instructions:
Mail Hosting:
Please provide details for any mail hosting for emails set up for the domain. Are these hosted on web servers or externally?
Mail Credentials:
Git Repository & Access:
URL to the current Git repository (if applicable) and access provided to Jump Development Team.
Please include confirmation of lead / development branches.
Git Provider
Git Repository URL:
Git Access / Credentials:
Lead Production Branch
Lead Staging / Development Branch
Details of any other development branches:
CMS Login Credentials:
Links to CMS login URL's and credentials to gain access.
Frontend (User) Login:
Administator Login:
Project Contacts:
Please list any main contacts for the project, including client details, project managers and application developers.
Project Summary:
Project summary and requirements
Project Frameworks & Technologies:
A detailed list of project frameworks, technologies and development dependencies used.
Project Key Functionality:
A breakdown of the website functionality and any details off customization to core / plugins files (if applicable).
Website Form & Submission Handling:
Details regarding current form integrations and form submission handling and how to manage these.
Development Process
Please detail the current development process with guides on how to compile development assets, detailing any dependencies versions required, such as NodeJS.
Development Guide:
Deployment Process
Please detail the current deployment process with guides on how to deploy changes to hosting environments.
Further Details / Additional Notes
Please add any further details and additional notes that you feel are needed for developers to be aware of in regards to the project and current development.
SMTP
Please provide details on the current SMTP integration (if applicable) and any credentials. Managed by client or internally?
Production SMTP
SMTP Provider
SMTP Account Credentials
SMTP Host
SMTP Username
SMTP Password
SMTP Port
SMTP Auth
SMTP TLS
Testing SMTP
SMTP Provider
SMTP Account Credentials
SMTP Host
SMTP Username
SMTP Password
SMTP Port
SMTP Auth
Third Party Integrations:
A list of any third party integrations (such as MailChimp, HotJar etc) and credentials.
Mailchimp Credentials
HotJar Credentials
Premium / Paid For Services:
Please document any premium or paid for services / integrations for the application. Please provide full details such as license keys and credentials if required.
SEO Tracking & Search Console Credentials:
Details of current SEO implementation with analytics tracking codes. (Universal, GA4, Tag Manager etc) Details regarding tracking and any bespoke tracking requirements.
Credentials for webmaster tools and search console accounts for the project.