Differential D38398 Diff 116869 website/static/status/report-sample.adoc

Changeset View

Standalone View

				=== Status Report Sample - This Will Become The Title

				Links: +
				link:http://www.example.com/project/url[Link description] URL: link:http://www.example.com/project/url[http://www.example.com/project/url] +
				link:http://www.example.com/other/url[Another link description] URL: link:http://www.example.com/other/url[http://www.example.com/other/url]

				Contact: Full Name <email@example.org>

				Paragraphs are separated with an empty line.
				If at all possible, write one sentence per line and don't split a sentence between lines.
				Use link:https://docs.asciidoctor.org/asciidoc/latest/syntax-quick-reference/[AsciiDoc syntax], if you can.
				If you don't know AsciiDoc, just use plain text.

				Introduce your work.
				Do not assume that the person reading the report knows about your project.

				Show the importance of your work.
				Status reports are not just about telling everyone that things were done, they also need to explain why things were done.

				What has happened since the last report?
				Let us know what is new in this area.

				If help is needed, make this explicit.
				List tasks, with enough detail that people know if they are likely to be able to do them, and invite people to get in contact:

				* First task
				* Second task
				* Additional tasks, if any …

				Optionally include the information about the sponsor.

				Sponsor: Sponsoring Organisation, if any