You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: how_to_write_good_articles.md
+23-24Lines changed: 23 additions & 24 deletions
Original file line number
Diff line number
Diff line change
@@ -10,22 +10,24 @@ Articles put useful information inside other people's heads. Follow these tips t
10
10
11
11
## General Tips
12
12
13
-
### Know Your Audience
14
-
15
-
Understanding your audience is crucial for effective technical writing. Before writing, consider:
13
+
### Don't Tell, Show
16
14
17
-
- Their technical background and experience level
18
-
- What problems they're trying to solve
19
-
- What information they need to succeed
15
+
Graphics and code snippets are more effective than text. Whenever possible, use them to explain your points instead of lengthy paragraphs.
20
16
21
-
For CodeCut articles, we write for data scientists who:
17
+
❌ Don't: Use only text to explain.
22
18
23
-
- Are proficient in Python
24
-
- Need to learn new tools quickly
25
-
- Want practical, working examples
19
+
> DuckDB is a fast, in-process SQL OLAP database management system. It supports standard SQL queries on Parquet and CSV files, and provides seamless integration with Python DataFrames. DuckDB is useful for analytics workloads on local data without needing a server.
26
20
27
-
Focus on delivering exactly what they need - no more, no less. Cut any content that doesn't directly help them solve their problem.
21
+
✅ Do: Use both text and code snippets to explain.
28
22
23
+
> You can query a Parquet file directly using DuckDB with a single line of SQL:
24
+
>
25
+
>```python
26
+
>import duckdb
27
+
>duckdb.query("SELECT COUNT(*) FROM 'data.parquet'").show()
28
+
>```
29
+
>
30
+
> This runs a SQL query on a local Parquet file without needing to load it into memory first.
29
31
30
32
### Use Action Verbs
31
33
@@ -41,24 +43,21 @@ SQL operations on DataFrames are provided by DuckDB without server setup.
41
43
DuckDB provides SQL operations on DataFrames without server setup.
42
44
```
43
45
44
-
### Don't Tell, Show
46
+
### Know Your Audience
45
47
46
-
Graphics and code snippets are more effective than text. Whenever possible, use them to explain your points instead of lengthy paragraphs.
48
+
Understanding your audience is crucial for effective technical writing. Before writing, consider:
47
49
48
-
❌ Don't: Use only text to explain.
50
+
- Their technical background and experience level
51
+
- What problems they're trying to solve
52
+
- What information they need to succeed
49
53
50
-
> DuckDB is a fast, in-process SQL OLAP database management system. It supports standard SQL queries on Parquet and CSV files, and provides seamless integration with Python DataFrames. DuckDB is useful for analytics workloads on local data without needing a server.
54
+
For CodeCut articles, we write for data scientists who:
51
55
52
-
✅ Do: Use both text and code snippets to explain.
56
+
- Are proficient in Python
57
+
- Need to learn new tools quickly
58
+
- Want practical, working examples
53
59
54
-
> You can query a Parquet file directly using DuckDB with a single line of SQL:
55
-
>
56
-
>```python
57
-
>import duckdb
58
-
>duckdb.query("SELECT COUNT(*) FROM 'data.parquet'").show()
59
-
>```
60
-
>
61
-
> This runs a SQL query on a local Parquet file without needing to load it into memory first.
60
+
Focus on delivering exactly what they need - no more, no less. Cut any content that doesn't directly help them solve their problem.
0 commit comments