Loading video…
All breakouts
122Text-HeavyListicle hookSaaS
Hook
I Never Start My Project Without These 5 Docs
@norman.dev
2.6K followers · usually 862 views a post
Views
103.9K
Likes
6.3K
Comments
45
Shares
720
Why it worked
The post provides a clear, actionable framework for project documentation that resonates with developers seeking efficiency and organization. The visual presentation of the file structure and the concise explanations of each document's purpose make it easily digestible and valuable.
Summary
The creator shares their personal documentation system, which consists of five Markdown files: PRD, DESIGN, ARCHITECTURE, SCHEMA, and RULES. They explain that this system helps them stay focused, reduce mistakes, and speed up development, enabling them to build projects smoothly.
Structure
- 1Introduction to the documentation system
- 2Explanation of the PRD file
- 3Explanation of the DESIGN file
- 4Explanation of the ARCHITECTURE file
- 5Explanation of the SCHEMA file
- 6Explanation of the RULES file
- 7Benefits of proper documentation and call to action
Call to action
Do you document before coding?
Show us your process in the comments!
On-screen text
I Never Start My Project
Without These 5 Docs
My Complete Context Folder
context
ARCHITECTURE.md
DESIGN.md
PRD.md
RULES.md
SCHEMA.md
This is my
Documentation System
Before coding, I make sure to fill
these 5 files to reduce mistakes and
speed up development.
I. PRD
(Product Requirements Document)
This file contains my project scope, mvp, goals,
technical requirements and success metrics.
This makes sure I strictly follow my plan and
idea from the start till the end and to stay
inside the scope of the project instead of being
distracted by other things.
2. DESIGN.md
This is where I make my design system
to prevent AI Slop designs.
It contains my branding identity, theme, colors, typography, spacing,
animations, accessibility, etc.
3. ARCHITECTURE.md
This file contains my System
Architecture, Top-Level System
Overview, Design Methodology, Design
Pattern, Data Flow, and other diagrams
or key implementations.
4. SCHEMA.md
This file is for database docs such as
my Schema, ERD, RLS policies, and
migrations. This file contents is
depending on your project tables.
5. RULES.md
My Coding And Implementation Rules
I make sure my code strictly follows SOLID
principles, uses DRY method if a function or
services repeated 4x or more, and KISS
method when shipping new functions and
business logic.
Proper Documentation
=
Faster Development,
Fewer Bugs,
and Maintainable Code
This system help me build zen berry
smoothly in just 9 days!
Do you document before coding?
Show us your process in the comments!
Original caption
These 5 documents help me stay originated, consistent, and fast throughout the entire project. Here's what each one contains 👇 1. PRD.md contains the scope of my project, its goals, mvp, technical requirements, and success metrics. 2. DESIGN.md contains the my branding identity, design themes, colors, fonts, spacing, animations, accessibility, etc. 3. ARCHITECTURE.md contains my Top Level Architecture of the project, system designs of my business logics and systems, data flow, folder structure, design methodologies, patterns. 4. SCHEMA.md is all database included contents like my tables, ERD, RLS policies, migrations, and models. 5. RULES.md is the hard rules instruction that my AI agent should always follow, like naming conventions, project scaffolding, coding principles. Which do you think is most important? Comment below! #codinglife #softwareengineer #fullstackdeveloper #codingtips #productivity