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: README.md
+9-4Lines changed: 9 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -49,21 +49,26 @@ Keep the following principles in mind:
49
49
50
50
-**Write for your audience** - Consider why users are reading your documentation and explain the use case clearly. Focus on clarity and completeness without being verbose. Add examples and code snippets when relevant.
51
51
-**Help users get something done**. Don't try to sell users on the product, and avoid marketing language like "amazing features" or "the best solution."
52
-
-**Write in clear, concise language**, using [active voice](https://developers.google.com/style/voice) whenever possible. Keep sentences and paragraphs short and to the point. Use a friendly, casual tone and stay away from jargon as much as you can.
52
+
-**Avoid time-specific language**. Don't mention a product or feature was just released or is the newest form, as this will quickly lead to stale documentation.
53
+
-**Write in clear, concise language**, using [active voice](https://developers.google.com/style/voice) whenever possible. Keep sentences and paragraphs short and to the point. Be conversational and friendly tone. Stay away from jargon as much as you can.
53
54
-**Use [Fern’s documentation components](https://buildwithfern.com/learn/docs/writing-content/components/overview)** whenever you can.
54
55
-**When editing an existing page** - Match the existing heading structure, tone, and level of detail to ensure your changes integrate as seamlessly as possible.
55
56
56
-
**For language and grammar help**, check out [Google's developer documentation style guide](https://developers.google.com/style) or Microsoft's [writing style guide](https://learn.microsoft.com/en-us/style-guide/welcome/)
57
+
> "Break any of these rules sooner than say anything outright barbarous."
58
+
>
59
+
> —George Orwell, "Politics and the English Language"
60
+
61
+
Our style guide is influenced by [Google's developer documentation style guide](https://developers.google.com/style) and Microsoft's [writing style guide](https://learn.microsoft.com/en-us/style-guide/welcome/).
57
62
58
63
### Getting changes reviewed
59
64
60
65
If you want to **add a new page or make a large structural change**:
61
-
-[File an issue in GitHub](https://github.com/fern-api/docs/issues) and assign @devalog and @kgowru. We'll review your issue to make sure your proposed page fits with Fern's overall documentation strategy and isn't duplicating any ongoing work.
66
+
-[File an issue in GitHub](https://github.com/fern-api/docs/issues) and assign [@devalog](https://github.com/devalog), [@kgowru](https://github.com/kgowru), or [@dsinghvi](https://github.com/dsinghvi). We'll review your issue to make sure your proposed page fits with Fern's overall documentation strategy and isn't duplicating any ongoing work.
62
67
63
68
For **all other changes**:
64
69
- Submit a PR directly with your suggested changes. A Fern docs member will review and confirm.
65
70
66
-
If you see something that is wrong or outdated in the documentation but don't know how to fix it, [file an issue](https://github.com/fern-api/docs/issues) or reach out to @devalog and @kgowru.
71
+
If you see something that is wrong or outdated in the documentation but don't know how to fix it, [file an issue](https://github.com/fern-api/docs/issues) or reach out to [@devalog](https://github.com/devalog), [@kgowru](https://github.com/kgowru), or [@dsinghvi](https://github.com/dsinghvi).
0 commit comments