ministryofjustice/cotton — pull request #44 by symroe (2014-11-04 12:42:26+00:00)
Title: vitruvius file

tl;dr, talk to me about this before merging, but do that soon please :)

## What is this?

"vitruvius" is a badly named project from GDS that aims to create a searchable directory of code, services and components across government [digital].

It's new, and they are trying some things out. We have been asked to test this by making these 'vitruvius.md' files in the root of some repos.

This file is like a manifest with some special tags in it to make displaying and searching the information easier.

An example of the end product can be fond here:

http://vitruviusweb-vitruvius.rhcloud.com/#/details?link=..%2Fservices%2FpaymentComponent

## Making this PR better

I've done by best to fill out the basic information, but the following could be added:

* Estate
* Data
* Technology
* Hosting
* Role
* References
* Further Reading
* Transactions (interactions with other services)
* APIs
* sub services
* Components used by this service
* Primary User Needs

The example template should explain more:

http://vitruviusweb-vitruvius.rhcloud.com/views/documents/template.md

If there is anything in the above that should be added, please either add it to this PR or tell me about it and I'll try to add it.

## Feedback

Please give me any feedback on this you might have I already have a lot of comments, but I'd like to give as much feedback as I can.