Skip to content

Commit d123e66

Browse files
fix style guideline
1 parent 9f16e79 commit d123e66

File tree

1 file changed

+11
-5
lines changed

1 file changed

+11
-5
lines changed

contribution.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -103,16 +103,22 @@ The exported HTML files will be automatically deployed to GitHub Pages through t
103103

104104
### Writing Style Guidelines
105105

106-
#### General Writing Style
106+
#### Tone and Structure
107107

108-
- Assume readers are data scientists who have basic programming knowledge but may be new to specific tools
109108
- Use direct, conversational language
110109
- Keep paragraphs short (2-4 sentences maximum)
111110
- Prioritize comprehensive but concise explanations without repetition
112111
- Maintain a balanced ratio of explanation to code (approximately 50/50)
113112

114113
#### Data Science Focus
115114

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

Comments
 (0)