The document title should focus on the general content of the document. For example: "Creating User Accounts in LDAP". Provide a summary of the overall document content just after the title.
The document should be broken up into logical sections. Each section should then contain step-by-step or checklist instructions.
For example, one section may be called "Adding a New User"
Each section should contain step-by-step instructions and/or a checklist of how to perform each action under the appropriate section. Include examples and images as needed.
- Verify user names meet convention requirements (1).
- From the command prompt, add the user to Ubuntu OpenLDAP Server:
sudo ldapadduser eggsham domainname
- User added to Ubuntu OpenLDAP Server
Add visual aids if necessary.
flowchart LR
A["Nightly Scheduled Task at 5:30am"] --> B{Test for New Input Files};
B ---->|"Input Files Do NOT Exist"| E[End];
B -->|"Input Files Exist"| C{"Import Data from Files"};
C ---->|"No New Data"| D["Email and End"];
C ---->|"New Data"| F["Create Accounts and Email"];
The reference area should be used to add any additional information or instructions on how to deal with more specific circumstances, and/or to reference any external sources of information.
(1) Section Title: Subtitle - Do not include hyphens (-) in user account names.
“LDAP Workstation Authentication.” n.d. Ubuntu. Accessed March 16, 2023. https://ubuntu.com/server/docs/service-ldap-usage.