This is a custom Confluence template that is intended to be re-used in the creation of workshops presented by ARCC on the Wiki. All of the content in these sections is intended to be replaced by the author of the workshop. The first step in this style guide is to ensure that the the page is in wide mode to maximize the real estate for content when possible. The Title of the Page should be the same as the Title of the workshop and this section should include a quick intro to the topic, why it’s important for ARCC users, and what users should expect to get out of this workshop. Next should be a Table of Contents macro in vertical format. The Table is intended to be used as an agenda section for presenter mode as well as navigation for non-presenting viewing so that users can find the documentation and navigate to what they need to brush up on. Finally, at the end of each section, there should be a divider to indicate the separation of “slides”Documentation of research data, also called, metadata is an often overlooked, but critical, aspect of research data management. It’s important to note that this type of metadata is not as simple as basic system metadata familiar to computer scientists such as file sizes, ownership, etc. When we are talking in a data management context, metadata provides several descriptive elements that inform viewers of the data of who collected it, how it was collected, where and when it was collected, processing methods, and much more. Not only is this a requirement for data publishing, it is very useful for collaboration between other researchers and can serve as a tool to ensure consistency throughout the other steps taken in the Research Data Management Life-cycle.
...
Table of Contents | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Headers and Sections
...
Common Metadata Standards
There are several standards available depending on discipline that provide the advantages of ensuring you have a complete, standard set of information about each part of your data and enable your dataset to be organized with other datasets, a few examples are:
While these standards exist and can help aid researchers in recording complete metadata, they are not universally required to be used. A best practice is to record the information that works for you and your collaborators.
...
Code Examples
Two Column Tables are nice ways to separate content/ Background info along with a code example on the same “Slide”. Please notice the table width. This should stop scroll bars from appearing
|
|
...