How thangchung/clean-code-dotnet works
Main Components
a) Core Educational Content Structure
• Major topic branches:
• Naming Conventions
• Variables
• Functions
• Objects & Data Structures
• Classes
• SOLID Principles
• Testing
• Concurrency
• Error Handling
• Formatting
• Comments
b) Supporting Resources Layer
• Cheatsheets Repository
• External Resources Links
• Code Examples
• Style Guides
• Tools References
Content Flow & Relationships
• Concept dependencies (e.g., basic principles leading to advanced topics)
• Implementation relationships between different sections
• Cross-references between related concepts
Documentation Integration
• References to specific sections in the README
• Links to relevant cheatsheets
• To external resources mentioned in the project
Implementation Notes
• Use a vector-based drawing tool for maintainability
• Make it exportable to common formats (SVG, PNG, PDF)
• Creating both detailed and overview versions
Remember to:
• Use consistent styling throughout
• Make it easy to navigate
• It's scalable for future additions
• Clear entry points for different skill levels