Skip to content

Commit 130968e

Browse files
author
Uma
committed
Added some writing guidelines
1 parent 3366232 commit 130968e

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

src/user/contributing.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,4 +49,12 @@ We are glad to know that you would like to contribute to the ``conda-forge`` doc
4949
5. Submit a `pull request
5050
<https://help.github.com/articles/about-pull-requests/>`_ to the main repository proposing your changes.
5151

52+
Writing guidelines:
53+
1. Identify your audience and Understand their skill level.
54+
2. Match the technical language with to the audience's skill level proficiency.
55+
3. Try to Keep it simple.Incase,if you have to use a lot of complicated terms provide a glossary of key terms
56+
4. Address the audience directly as user(s).
57+
5. While mentioning about an action, use the "command" form of the verb: "Choose an option from the menu and press Enter."
58+
6. For reference,Provide links to related content.
59+
5260
Happy contributing!

0 commit comments

Comments
 (0)