Technical-Writing

Maintainers

@Anushreebasics @vanivaranya

Mentors

@vaniasetia @trisha-tomy @dwiti28 @joyetaahuja

Please reach out to the maintainers if you get stuck or wish to report someone.

Abstract

Technical Writing Guidelines and Contribution Welcome to our technical writing repository! This project aims to create comprehensive and user-friendly technical documentation for various software projects. We believe that well-written documentation is crucial for the success of any project, as it enables users and developers to understand, use, and contribute to the codebase effectively.

To get started with contributing to our technical writing project, follow these steps:

1. Fork the Repository: Click the "Fork" button at the top right of this repository to create your copy.

2. Clone the Repository: Clone the forked repository to your local machine using the following command: git clone https://github.com/your-username/technical-writing.git

3. Create a Branch: Create a new branch for your contribution: git checkout -b feature/your-feature-name

4. Make Changes: Make your contributions to the documentation.

5. Commit Changes: Commit your changes with a clear and concise commit message: git commit -m "Add your message here"

6. Push Changes: Push your changes to your forked repository: git push origin feature/your-feature-name

7. Create a Pull Request: Open a pull request from your branch to our main repository. Ensure your pull request includes details about the changes made.

Steps to Get Started:

1. Browse Projects: Go through the projects listed on our website or GitHub repository and find one you feel comfortable contributing to.
2. Explore Issues: Look at the existing issues of your selected project and find one that interests you. Alternatively, you can create issues on your own.
3. Tag Maintainers: Tag repository maintainers (mentioned in the README) if you encounter any problems.
4. Get Issue Assigned: Wait for the issue to be assigned to you before starting your work.
5. Fork the Repository: Create a branch for the issue you’re working on.
6. Submit Your Work: Create a Pull Request (PR), mentioning the issue number and the changes made by you. It will be promptly reviewed, and suggestions will be provided if needed.
7. Add Screenshots: Attach screenshots to your PR to demonstrate your contribution.
8. Follow Repository Guidelines: Each repository's README contains specific contribution guidelines.

Contribution Guidelines

We welcome contributions from the community to enhance and maintain our technical documentation. Please adhere to the following guidelines:

1. Be Clear and Concise: Write clearly and concisely to ensure that readers can easily understand the information.
2. Use Proper Grammar and Spelling: Maintain a high standard of language in your contributions.
3. Provide Examples: Whenever possible, include examples and code snippets to illustrate concepts.
4. Follow the Documentation Structure: Stick to the outlined documentation structure to maintain consistency.
5. Check for Updates: Before making contributions, check if there are any existing issues or discussions related to the topic you plan to cover.