https://github.com/vintasoftware/user-documentation-checklists

General guidelines on how to build awesome SaaS user documentation!
https://github.com/vintasoftware/user-documentation-checklists

Last synced: 6 months ago
JSON representation

General guidelines on how to build awesome SaaS user documentation!

• Host: GitHub
• URL: https://github.com/vintasoftware/user-documentation-checklists
• Owner: vintasoftware
• Created: 2020-05-28T20:05:10.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2020-05-29T20:15:46.000Z (about 6 years ago)
• Last Synced: 2025-01-20T16:22:12.767Z (over 1 year ago)
• Size: 51.8 KB
• Stars: 3
• Watchers: 3
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
[![alt text](https://s3-sa-east-1.amazonaws.com/www.vinta.com.br/images/dont_delete/devchecklist-logo.png "Devchecklists Logo")](https://www.devchecklist.com)

## Creation and Submission:

### Follow the steps above to create and deploy your checklist:

  * [ ] 1. Fork this repository;

  * [ ] 2. Rename the forked repository;

  * [ ] 2. Use `checklist-*.md` to write your first checklist;

    * E.g. `checklist-en`.

  * [ ] 3. On the `checklist-*.md` file replace `*` for the [acronym language](https://www.loc.gov/standards/iso639-2/php/code_list.php) that your checklist was written;

  * [ ] 4. Go to [collaborate section](https://devchecklists.com/collaborate) on Devchecklists and submit your checklist for approval.

## Adding a New Language:

  * [ ] To add a new language you will need to create another markdown file containing the new [acronym language:](http://sustainablesources.com/resources/country-abbreviations/)

    * E.g. `checklist-pt.md`.

  * [ ] No further approval will be necessary;

  * [ ] The new checklist language should be visible on Devchecklists after you saved this new file on the repository.

## Important Notes:

  * [ ] Markdown is the only way to write checklists on Devchecklists;

  * [ ] For tips about how to use markdown to write checklists, please take a look at these raw files:

    * [ ] [`checklist-en.md`](https://raw.githubusercontent.com/vintasoftware/devchecklists-template/master/checklist-en.md) sample markdown;

    * [ ] [`README.md`](https://raw.githubusercontent.com/vintasoftware/devchecklists-template/master/README.md) contained on this repository;

    * [ ] Another checklists markdowns from [Devchecklists](https://devchecklists.com).

  * [ ] Changes on the checklist repository will reflect on the current checklist of Devchecklists.

## Commercial Support

[![alt text](https://avatars2.githubusercontent.com/u/5529080?s=200&v=4 "Vinta Logo")](https://vintasoftware.com)

This project, as other Vinta open-source projects, is used in products of Vinta clients. We are always looking for exciting work, so if you need any commercial support, feel free to get in touch: contact@vinta.com.br

Copyright (c) 2018 Vinta Serviços e Soluções Tecnológicas Ltda.

[MIT License](LICENSE.txt)