Standardize documentation with README templates

Have more questions? Submit a request
Who can do this? You will need to be an admin user in Atlan to create README templates.

READMEs add context to your data assets. README templates simplify and standardize the README documentation process.

Admin users in Atlan can create, curate, and manage the templates from the governance center. Once admin users have created the templates, other users will be able to select these templates and enrich the asset profile of their assets. They will also be able to see a rich preview of each template before adding the relevant documentation.

Define your README templates

Begin by asking what kind of information will be most helpful for the people who work with the data.

A good starting point is going over all the questions that you and your team of metadata curators have received from your organization in the past few months about your data. We recommend checking out the 5W1H framework to help you define your ideal template.

Create your README templates

 

To create your own README templates, complete these steps:

  1. In the left menu in Atlan, click Governance.
  2. Under the Governance heading, click Readme templates.
  3. In Readme templates, click Get started.
  4. In the Untitled Template dialog box, enter the following details:
    1. For template name, type a name for your template.
    2. For template description, add a description.
    3. (Optional) To add an icon, click on the image icon.
  5. Click Create to proceed. 
  6. In the text editor, add your template.
  7. Click Save.
  8. (Optional) To edit the template, in the upper right of the screen, click the pencil icon. 

Your README template will now be available in the templates manager!

Related articles

Was this article helpful?
1 out of 1 found this helpful