added more files
This commit is contained in:
21
.github/instructions/documentation.instructions.md
vendored
Normal file
21
.github/instructions/documentation.instructions.md
vendored
Normal file
@@ -0,0 +1,21 @@
|
||||
---
|
||||
applyTo: "*.md"
|
||||
---
|
||||
# Project documentation writing guidelines
|
||||
|
||||
## General Guidelines
|
||||
- Write clear and concise documentation.
|
||||
- Use consistent terminology and style.
|
||||
- Include code examples where applicable.
|
||||
|
||||
## Grammar
|
||||
* Use present tense verbs (is, open) instead of past tense (was, opened).
|
||||
* Write factual statements and direct commands. Avoid hypotheticals like "could" or "would".
|
||||
* Use active voice where the subject performs the action.
|
||||
* Write in second person (you) to speak directly to readers.
|
||||
|
||||
## Markdown Guidelines
|
||||
- Use headings to organize content.
|
||||
- Use bullet points for lists.
|
||||
- Include links to related resources.
|
||||
- Use code blocks for code snippets.
|
||||
Reference in New Issue
Block a user