📘
Engineering Communications Program Team Projects
Open Source Guide
Open Source Guide
  • Welcome
  • Creators
    • Reasons to create
    • Create a repository
      • Set up documentation
        • README
        • CONTRIBUTING
        • License
    • Name your project
    • Build a community
      • Communication Mediums
        • Mass Notifications
        • Formal Exchanges
        • Real-Time Messaging
      • Code of Conduct
    • Additional Resources
  • Contributors
    • Reasons to contribute
    • Find a project
      • GitHub Trending
    • Ways to contribute
    • Choose an issue
    • Read supporting documentation
    • Git Workflow
      • Fork a project
      • Create a branch
      • Add a commit
      • Submit a pull request
      • Review code
Powered by GitBook
On this page
  1. Creators
  2. Create a repository

Set up documentation

Once the project has been created, it’s time to lay its framework. This is done through documentation. Documentation needs to be three things: easily readable, referenceable, and accessible. If all three are met then your documentation will be as clear as it can possibly be. Be sure not to make any assumptions about the audience's technical abilities. Explain the project from the top down so that other developers feel welcomed into the project.

Now that there’s a good understanding of why documentation is important, it’s time to address the three main pieces of documentation: README.md, CONTRIBUTING.md, and the License. These three files cover everything needed to have a solid framework for your project. The next three sections will cover each of these files in-depth.

PreviousCreate a repositoryNextREADME

Last updated 3 years ago