From the course: Creating Technical Documentation with GitHub
Join today to access over 25,000 courses taught by industry experts.
Naming conventions: Part 2 - GitHub Tutorial
From the course: Creating Technical Documentation with GitHub
Naming conventions: Part 2
- "Naming Conventions," part two. Follow a logical sequence to number files if they should be read in a particular order. For an example tutorial, okay. Let me give you an example. "01-installation.md." "02-configuration.md." "03-usage.md." Can you see that it is giving you a signal and what is that? It's telling you that you should read 01-installation.md before reading 02-configuration.md before going to 03-usage.md. So it's a sense of pattern that makes you realize that you need to read this particular aspect before going to the next, and the next has been specified for you already as 02. Next after that is 03. "Directory names." Similar rules apply to directories. Name folders to reflect the type of content they hold. That do help a lot. For an example, "Introduction," you'll know that inside the introduction folder, the only thing you will find there is the introduction to that particular course or write up. "User guide." You know that everything you're going to see inside the…
Download courses and learn on the go
Watch courses on your mobile device without an internet connection. Download courses using your iOS or Android LinkedIn Learning app.
