{"id":292,"date":"2022-11-29T21:39:10","date_gmt":"2022-11-29T21:39:10","guid":{"rendered":"http:\/\/learnlearn.uk\/ibcs\/?page_id=292"},"modified":"2023-02-08T08:33:55","modified_gmt":"2023-02-08T08:33:55","slug":"system-documentation","status":"publish","type":"page","link":"https:\/\/learnlearn.uk\/ibcs\/system-documentation\/","title":{"rendered":"System Documentation"},"content":{"rendered":"
\n

User<\/h2>\n
\n\n

User Documentation<\/h3>\n

In order for users to work with large, complex and and rapily evolving systems, it is important that the correct user documentation is put in place. This can include:<\/p>\n

Printed Manuals<\/strong><\/p>\n

Traditional systems included huge user manuals with hundreds of pages. These have largely been replaced or slimmed down to ‘getting started’ guides, due to the rapid pace of development of systems, as well as the recent shift to remote or hybrid working environments.<\/p>\n

Online-wiki pages<\/strong><\/p>\n

Most systems now have electronic manuals, either openly available online or on a restricted intranet site.<\/p>\n

Tutorial Videos<\/strong><\/p>\n

Tutorial videos are often an excellent form of user documentation that is especially useful in demonstrating system processes.<\/p>\n

FAQs<\/strong><\/p>\n

Most systems have an FAQ system for users, answering the most common questions that come up.<\/p>\n

Help tabs & Tooltips<\/strong><\/p>\n

Help can be built directly into the system with help tabs, tooltips and popups.<\/p>\n

Troubleshooting Guides<\/strong><\/p>\n

 <\/p>\n\n<\/div>

Technical<\/h2>\n
\n\n

Technical Documentation<\/h3>\n

Technical documentation is a necessary component of any system, detailing:<\/p>\n