mirror of
https://github.com/status-im/write.status.im.git
synced 2026-08-30 17:21:11 +00:00
33 lines
1.9 KiB
Markdown
33 lines
1.9 KiB
Markdown
---
|
|
id: 12
|
|
revision: 3
|
|
hide:
|
|
- navigation
|
|
---
|
|
|
|
# Welcome
|
|
|
|

|
|

|
|
|
|
The Status writing style guide aims to provide easy-to-follow guidelines for writing clear and well-structured documentation. Writers or contributors can use this guide for 90% of their needs; for the remaining 10%, use the [Microsoft Style Guide :octicons-tab-external-16:][microsoft-style-guide]{:target="_blank"}.
|
|
|
|
This guide doesn't contain lengthy linguistic explanations. Instead, it's intended to be a simple, real-world resource for anyone willing to contribute to the Status documentation, from writers ready to document product functionalities to casual contributors who want to improve the existing content.
|
|
|
|
The [Style guidelines](style-guidelines.md) section describes Status general approach to technical writing style and content structure. In [Structuring the content](./structuring-the-content.md), you can find the different types of articles in the Status documentation, including directions on structuring your content. The [Style conventions](./style-conventions.md) section serves as a reference to the different styles in the Status documentation. Finally, [Terminology](./terminology.md), provides a list of common Status product names, as well as icon names and user interface areas names in the Status apps.
|
|
|
|
Refer to our [documentation contributor's guide][contributors-guide] to contribute to this guide or the Status documentation.
|
|
|
|
!!! note
|
|
The Status writing style guide doesn't include information on writing developer documentation. This information will be included in a future version.
|
|
|
|
<div class="grid cards" markdown>
|
|
|
|
- [Style guidelines][style-guidelines]
|
|
- [Structuring the content][structuring-the-content]
|
|
- [Style conventions][style-conventions]
|
|
- [Terminology][terminology]
|
|
|
|
<br>
|
|
|
|
--8<-- "includes/urls-style-guide.txt" |