Onboarding Documentation Guide

Welcome to our team! This guide will help you understand the rules and procedures for working with us. Follow these guidelines to ensure smooth operations and maintain the quality and security of our projects.

General Rules

You must comply with all the rules specified here.

1. Backup Files: Always backup files before and after your shift and upload them to this Google Drive folder in the folder of the current date.
2. Approval for Changes:
   • NEVER edit a plugin, theme, or WordPress file without approval.
   • NEVER update a plugin, theme, or WordPress file without approval.
   • Always ask for permission to add CSS to Elementor widget additional CSS.
3. Code Placement:
   • ONLY add code in the child theme or our custom plugin as requested when the task is assigned.
   • Never add CSS in WordPress customizer or Elementor’s code page.
4. Code Comments: Every line or block of code (CSS, JS, PHP) must be commented. The comment must be succinct and descriptive.
5. JavaScript Usage: We never use jQuery; only vanilla JavaScript is allowed.
6. Library Approval: Do not use any PHP or JS libraries without asking for permission.
7. HTML Attributes: We never use ID or class to identify a div; we use data attributes, such as data-contact-form-container, data-contact-form-username, etc.
8. Permission for Edits: If editing existing CSS, JS, or PHP, you need to request permission on slack and provide a reason why.
9. CSS Flexbox: Always use flex when working with CSS.
10. Viewport Testing: Check work across all viewports. Always check your work in various viewports, ensuring it looks good and responds well. Slowly resize your browser to verify responsiveness.

Security

1. Do Not Store Passwords Locally:
   • Avoid saving any passwords or FTP credentials on local machines or in unencrypted files.
2. When saving to FTP program site, always protect with a master password
3. Use a Password Vault:
   • Select a reputable password manager such as LastPass, 1Password, or similar.
   • Store all passwords and FTP credentials in the chosen password vault.
4. Protect the Master Password:
   • Create a strong, unique master password.
   • Enable multi-factor authentication (MFA) for additional security.
5. Share Credentials Securely:
   • Use the sharing features within the password manager to share credentials.
   • Utilize expiring links or temporary access options for sharing.
   • Avoid sharing credentials via email or other insecure methods.
6. Always use SFTP where possible:

By following these steps, you ensure the security and proper management of sensitive credentials.

Shift Notes

Always send a message on Slack indicating you are starting your shift.

At the end of each shift, you MUST send a message on Slack summarizing the following:

• Hours Worked: Indicate the start and end times of your shift, as well as total hours worked for the day.
• Tasks Completed or Worked On: List the tasks you have completed or worked on, along with their statuses (complete / incomplete).
  • If using a project management tool (Asana, Trello, ClickUp, etc.), add the link of completed tasks and pending tasks.
• Files Worked On: List the files you worked on, including PHP, CSS, JS files, and Elementor or WordPress admin pages or settings.
• Next Shift Time: Indicate the start time of your next shift.

Example Shift Notes

SHIFT NOTES
DATE: 12/07/2024
HOURS WORKED: 9am - 3pm
TOTAL HOURS WORKED: 6 hrs
TASKS COMPLETED:
- [Task 1 Link]
- [Task 2 Link]
TASKS STARTED:
- [Task 3 Link]
- [Task 4 Link]
FILES WORKED ON:
- path/to/file1.php
- path/to/file2.css
- Elementor page link
- WordPress edit page link
NEXT SHIFT: 9am GMT+10

Project Management Tool Notes

When completing tasks assigned in Asana, Trello, ClickUp, etc, you must always:

• Upload a screenshot of the completed task, fix or a video demo of the task in the comments.
• Add in the comments section of the task all the PHP, CSS, JS file paths, WordPress or Elementor settings, admin URLs worked on, and the link to the page to test the work.
• Please ensure to click on each subtask in Asana as you complete them. However, do not mark the main task as complete—I will handle that.
• If you are working on a large project, check for new tasks assigned to you daily.

By following these guidelines, you’ll help ensure our projects are maintained to a high standard and that we can work efficiently as a team. Thank you for your cooperation and welcome aboard!