Feedback: I have a comment on a particular chapter’s content

[cansavvy]

Which course have you been following?

Documentation_and_Usability

What platform have you been following this course on?

Bookdown

Type of feedback:

I have a comment on a particular chapter’s content

Description

Hello, I have a comment about 'Chapter 11 How to keep your documentation up to date'. Something that we've talked about on the ITCR Training and Outreach calls and that I have personally found to be very useful in keeping documentation up-to-date is to write a particular piece of documentation only once and then link to it from any relevant place. For instance, if you have documentation about what the colors mean for a particular visualization, only put that information in one place and then everywhere else in the documentation that it would be good to include that information you link back to that one place. This prevents information from being duplicated in many places, which in turn makes it easier to remember all the places that need to be updated. Not sure if it would be relevant here or not but I have found it to be useful and not something I would have known to do on my own.

Email:

mgoldman@ucsc.edu