From the course: Creating Technical Documentation with GitHub
Join today to access over 25,000 courses taught by industry experts.
Naming conventions: Part 1 - GitHub Tutorial
From the course: Creating Technical Documentation with GitHub
Naming conventions: Part 1
- [Instructor] A well-organized file structure and clear naming conventions are essential in technical documentation for maintaining clarity, consistency, and scalability. The app developers and users easily navigate and understand the project's structure. Now, let's talk about the file structure and the naming conventions. Your documentation should be organized into distinct sections at a top-level based on the content's type. A typical structure is what we have on the screen. We have a folder, which is docs, and inside docs folder we have different sub folders. Introduction folder, user-guide folder, developer-guide folder, references folder. In introduction folder, we have a file called getting-started.md, okay, which is markdown file, good. Next, we have a folder called user-guide folder. Inside user-guide folder, we have three files, installation.md, usage.md, faq.md. Next we have developer-guide, and inside developer-guide we have the api folder, and inside api folder, we have…
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.
