Watch videos with subtitles in your language, upload your videos, create your own subtitles! Click here to learn more on "how to Dotsub"

use-documentation-overview

0 (0 Likes / 0 Dislikes)
[00:00:06] We'll be discussing a few topics about documentation. We'll cover some ideas, tips and tricks, and hopefully help you along your path for a successful implementation. So, why documentation? First of all, minimum documentation is needed. Dynamics 365 is self-documented, and most of the out-of-the-box configurations can be reviewed through tools such as dependency tracker, the new activity log functionality for auditing and administrative changes. What is not automatically recorded is the intention behind customizations and configurations, and the business requirements being met, and the changes. These are important to documents so that they can be reviewed while planning future changes and onboarding new technical resources. User training documentation often fall under documentation and are very important for increasing user adoption and providing consistent training best-practice. Keep your audience in mind. You will often write multiple pieces of documentation for the same features to accommodate your audience. Some definitions - write down definitions, especially for internal teams and when teams have changed. For example, if ‘leads’ are called ‘prospects’ in your old system, it is important to make that clear. Architecture and design documentation - This needs to include intentions, design decisions, requirements and known expectations, and related features that are out of scope. The documentations should state the reasons for the decisions made and any concessions made, and the reasons for those, such as manual input instead of an integration due to cost. Also, it needs to account for integration points and dependencies. Technical documentation – APIs, reference material for developers and technical resources. [00:02:04] Any custom code should be documented in these ways. End-user documentation - When they start, your users will want step by step instructions, like following a recipe. As they get used to the product, they'll be more interested in how to apply what they know to other projects and accomplish things not outlined in the step by step documentation. Be very clear on the difference between required processes and bonus features. For example, not every salesperson will use recently viewed items, but all must track their opportunities with estimated revenues. It can be helpful to make a series of short one-page tutorials for each distribution and user supported. Internal marketing - The benefits of application, the problems it solves, how does it fit into the grade of vision, etc., should be circulated. And then, Change logs. Changes need to be tracked. At a minimum, you should note the changes, the time, the date, the resources making the changes. And, ideally, you should also include the intention for the changes and the areas impacted by the changes, and a link to the testing plan. You might be thinking ‘How does user adoption testing have anything to do with documentation?’ Well, UAT testing is a great time to test your documentation. A new user should be able to complete the needed tasks for UAT testing with the help of your documentation. Any questions that come up may call out holes in your documentation.

Video Details

Duration: 3 minutes and 47 seconds
Country:
Language: English
License: Dotsub - Standard License
Genre: None
Views: 5
Posted by: csintl on Feb 14, 2019

use-documentation-overview

Caption and Translate

    Sign In/Register for Dotsub above to caption this video.