This is what I do, but your situation might vary.
- Meet with the project manager (PM) to learn the following:
- software business cases (What problems does it solve?)
- doc needs (User guide? Release notes? Admin guide?)
- doc audience (External customers? Internal business units?)
- estimated deployment dates to Quality Assurance (QA) and production environments
- name of the lead developer
- Ensure the PM adds you to any project meetings or Agile ceremonies.
- Ask the lead developer for access to the software’s development environment. Ensure they’re okay with you playing hard with it.
- Write chapter and section headings for tasks based on the business cases. Start them with verbs (“Add a user”) and organize them into a logical process flow.
- Play hard with the software. Note any bugs, misspellings, confusing user interface elements, etc., and pass them on to the lead developer.
- Write the steps needed to complete each task. Start each step with a verb (“Click Add User” or “Type the user’s name”).
- Complete a review draft 1-2 weeks before QA deployment and send it to the project manager and lead developer for review.
- Edit the draft as needed and obtain sign-off from the PM and lead developer.
- Send it to the QA team as a reference for their testing. Update the document with changes that come out of QA.
- Publish the document with production deployment.
- In a perfect world, all these steps flow smoothly and the project finishes on time. But we do not live in a perfect world and I’ve never had a project flow smoothly. Dates will be missed, review requests will be ignored, changes will be implemented without you knowing. So the most important step of all: Keep calm, adapt, and carry on.