https://github.com/mekras/hwd

Как писать документацию
https://github.com/mekras/hwd

documentation guides references

Last synced: over 1 year ago
JSON representation

Как писать документацию

• Host: GitHub
• URL: https://github.com/mekras/hwd
• Owner: mekras
• License: other
• Created: 2018-12-24T16:45:19.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2021-01-19T07:12:41.000Z (over 5 years ago)
• Last Synced: 2025-01-25T07:07:10.315Z (over 1 year ago)
• Topics: documentation, guides, references
• Language: Python
• Size: 198 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md

Awesome Lists containing this project

README

          
# [кпд.онлайн](http://кпд.онлайн/)

[![CC BY-NC-SA](https://i.creativecommons.org/l/by-nc-sa/4.0/80x15.png)](http://creativecommons.org/licenses/by-nc-sa/4.0/)

[![Состояние сборки](https://travis-ci.org/mekras/hwd.svg?branch=master)](https://travis-ci.org/mekras/hwd)

Этот сайт посвящён написанию документации, связанной с программным обеспечением и его разработкой.

Собранные здесь статьи, в первую очередь, предназначены для разработчиков и технических писателей,

но в некоторых случаях могут оказаться полезными и другим аудиториям.

Разработка ПО сопровождается самой разнообразной документацией: требования, задания, правила,

справочники, руководства. Хорошая документация может стать мощным инструментом ускорения разработки

ПО и важной составляющей его популярности. И наоборот — плохая документация или её отсутствие могут

стать источником ошибок при разработке приложения или причиной отказа разработчиков от хорошей

библиотеки.

* [Правила участника](CONTRIBUTING.md)

## Разработка

### Запуск локального сервера

    make start-server