✏️
Alaska Region Interim Data Management User Guide
  • Alaska Region Interim Data Management User Guide
  • Background
    • Why Data Managment?
    • The Big Picture: Integrating Data Management with Project Management
    • Definition of Project and Product (aka Data Resources)
  • Four Fundamental Activities of Data Management
    • Establish Roles and Responsibilities
    • Quality Management
    • Security and Preservation
    • Documentation
  • Alaska Data Management 101
    • Workflow
    • File Organization and Best Practices
      • Best Practices in Naming Conventions
      • Best Practices for Version Control
      • Changelog Best Practices
    • Alaska Regional Data Repository
    • Data Management Policy
  • Plan
    • Why Data Planning?
    • Data Management Plan Templates
      • Data Standards in brief
    • Project & Data Management Integration
    • Considerations for Projects with External Partners
  • ACQUIRE
    • Common Data Types
      • Open Formats
      • Best Practices in Tabular Data
      • Best Practices in Databases
      • Best Practices in Geospatial Data
      • Best Practices with Collections of Similar Types of Data
      • Best Practices with Source Data
    • Quality Management Procedures
      • Incorporating Data Standards
      • Using Unique Identifiers
  • MAINTAIN
    • Update Metadata
  • Access & Share
    • Open Data Requirements
      • Obtaining a Digital Object Identifier (DOI)
      • Obtaining a URL
      • Sharing without a URL
  • Long-term Storage Options
    • Using the Regional Data Repository
    • Public Accessible Repositories
  • Records Schedule & Disposition
  • Data Management Actions Quick Guide
  • Glossary
Powered by GitBook
On this page

Was this helpful?

  1. Alaska Data Management 101
  2. File Organization and Best Practices

Changelog Best Practices

Describes Use and Best Practices for READ ME files

PreviousBest Practices for Version ControlNextAlaska Regional Data Repository

Last updated 2 years ago

Was this helpful?

Also often titled a "README" file, this text tile serves as a project folder much like a table of contents of a book or a report. It outlines what you will find inside and provides a space for noting changes in the contents.

Some basic elements of this text file may include:

  • Project title--add your project title at the top of the text file

  • Contact information--include name, and contact information

  • Overview--include what files will be found in the project archive and descriptions of the information in the files

  • Instructions--include details on how the files should be used together

  • Change Log--notes on any additions, subtractions, or corrections made to the associated files

Updated August 2022