UG process info session

User Guide Delivery process

Who am I ?

What is the purpose of today's info session?

• Clarify to you our process
• How can your involvement make things smoother ?
• What are the practices that we apply to deliver optimal results?

How does the Change KM team proceeds ?

In the context of a deployement

Regularly

Process

Release

User Guide Creation/ Update

• User Empowerment and Change Governance teams work togther to deliver the final user guides in time

• A mail is sent by the User Empowerment team 5 weeks prior to the release. ​

Important links and dates

• Process launch

• Confirmation of the release topics and communication content

• User Guide content delivery
• User Guide Delivery

UG Creation/Update Process

How does the Change KM team proceeds ?

In the context of a deployement

Regularly

Deployement specific actions

Post fit and gap, comunication is key for an effective delivery of the User guides and trainings in time for the UAT

Best Practices

Things changed with Aptilink...

Before

• Everybody had access to the modification of the UG
• No set template
• Long navigation paths
• Confusion between context and objectives

After

• Only the Change KM Team, BPOs and Directors have access to modification on the Help Platform
• Creation of a set template ( example will be given)
• KM team started having more responsibility on the quality check of the content after the Upskilling of the team
• Creation of a "Good Practices Guide".

What would be the best practices for you?

Checking if a User Guide exists

Effective communication

Clear instructions

When Creating a User Guide, we ask ourselves

Illustrations and Visuals

Lingustic Quality

Clarity of Instructions

Updates Management

Parasite Information

Thank you!

Any question?

User Guide update / Creation is the process of centralising all requests in order to allow the KM team to treat and deliver the best quality content within the deadlines

Update of a user guide occurs when:​

• A new part/chapter is added in an existing user guide.​
• Chapters need to be deleted.​
• Screenshots need to be replaced.

Clarity of Instructions and Relevance of Information:

• Are the instructions concise and intelligible, or do they need rephrasing for clarity?
• By following the step-by-step process, can users easily perform the described transaction?
• Are all included texts essential for understanding the process?​

Elimination of Irrelevant Information:

• Can non-essential or distracting information be removed from the guide?

(Always do it when possible)

The release is planned to communicate newly available updates, new transactions, etc in the Codex landscape.

Version Management and Updates:

• Are the guide’s details up-to-date with recent system developments?

Linguistic Quality and Clarity:

• Are there any typos or spelling mistakes in the user guide?
• Is the guide clearly organized for an easy navigation?
• Can readers easily understand the purpose of the function or transaction described in the guide?

Creation of a user guides occurs when : ​

• It is a new transaction/interface.​
• A new process is replacing an old one.​

Illustrations and Visual Support:

• Are the provided examples and templates clear and relevant?
• Are images correctly numbered and aligned with the given instructions?