Kent continues his discussion about the open source community by sharing his recommendations for creating documentation. He suggests using third-party sites like jsbin.com for providing code examples and explains how to use some Github-provided templates for managing issues.
(bass and flute music)…- So now we're back to the community aspect.…This is the stuff that I wanted to mostly talk about.…So, for the documentation side,…a couple of you in the pre-event survey…mentioned that one thing that you really want…to get out of this workshop is how to write…proper documentation for a library,…and so here's what I suggest:…the first thing that you write about…is what the problem is that you're trying to solve.…How many people have heard of start with why,…the concept of starting with why?…It's fantastic,…and basically, the premise is,…what makes people really loyal to companies…is those companies that understand why they're doing…what they're doing and communicate that well…to the people who are purchasing their products.…
And in the same way, I think we can communicate why…to the people who are using our open-source libraries.…So, document the problem.…What are you trying to solve?…And that should be one of the first things that you do.…And that can be as simple as like a single line of like,…
Note: This course was created by Frontend Masters. It was originally released on 08/09/2016. We're pleased to host this training in our library.
- Creating an open-source library
- Linting and testing
- Code coverage
- Installing and configuring Babel
- Peer dependencies
- Forking and renaming
- Continuous integration and automating releases
Skill Level Intermediate
1. Creating an Open-Source Library
2. Linting and Testing
3. Git Hooks, Babel, and Webpack
4. Continuous Integration and Automating Releases
- Mark as unwatched
- Mark all as unwatched
Are you sure you want to mark all the videos in this course as unwatched?
This will not affect your course history, your reports, or your certificates of completion for this course.Cancel
Take notes with your new membership!
Type in the entry box, then click Enter to save your note.
1:30Press on any video thumbnail to jump immediately to the timecode shown.
Notes are saved with you account but can also be exported as plain text, MS Word, PDF, Google Doc, or Evernote.