@@ -103,16 +103,22 @@ The exported HTML files will be automatically deployed to GitHub Pages through t
103
103
104
104
### Writing Style Guidelines
105
105
106
- #### General Writing Style
106
+ #### Tone and Structure
107
107
108
- - Assume readers are data scientists who have basic programming knowledge but may be new to specific tools
109
108
- Use direct, conversational language
110
109
- Keep paragraphs short (2-4 sentences maximum)
111
110
- Prioritize comprehensive but concise explanations without repetition
112
111
- Maintain a balanced ratio of explanation to code (approximately 50/50)
113
112
114
113
#### Data Science Focus
115
114
116
- - Begin with a real data science problem and its solution
117
- - Focus on features that directly benefit data scientists
118
- - Explain the practical value of each feature
115
+ - Begin with a real, practical data science problem before introducing the tool
116
+ - Focus on how each tool or feature helps solve that problem
117
+ - Always explain the ** practical value** of a feature (e.g., saves time, reduces costs, enables offline workflows)
118
+ - Avoid tool-first framing. Tools should support a use case, not be the center of the article
119
+
120
+ #### Reader Experience Assumptions
121
+
122
+ - Assume readers are data scientists who have basic programming knowledge but may be new to specific tools
123
+ - Write for readers who scan, not follow step-by-step; they want to * understand* , not necessarily * run* the code
124
+ - When mentioning install commands or configuration flags, keep them minimal and link out to official docs for details
0 commit comments