Functional spec template

For documentation on how to use this template more effectively reference the Writing functional specs page.

Tag

Publishing guidelines

Description goes here. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nunc pulvinar non felis non rutrum. Vestibulum fringilla imperdiet elit non aliquam. Cras consequat in mi non facilisis. Nam pellentesque ante urna, vitae venenatis sem placerat sit amet. Praesent dignissim tristique lobortis. Donec dignissim est in odio auctor, non ultricies diam bibendum. Nam cursus venenatis rutrum.

{{Overview image | full width}}

---

Table of contents

• 1. Level 1
  • 1.1 Level 2
• Callout examples

Dependencies (3)

• Component name 1
• Component name 2
• Component name 3

Back links (2)

Writing functional specs (2)

• Functional spec template includes the sections most commonly needed
• ...here is a link to the functional specs template: Functional spec template

Resources

• r1: Resource 1
• r2: Resource 2
• r3: Resource 3

---

1. Level 1

tag tag

Brief description might go here. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nunc pulvinar non felis non rutrum.

{{Scoped image | resize}}

1.1 Level 2

tag tag

Brief description might go here. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nunc pulvinar non felis non rutrum.

{{Scoped image | resize}}

Logic

	condition	description
#.#.#	...	...
#.#.#	...	...
#.#.#	...	...

Events

	name	description
#.#.#	...	...
#.#.#	...	...
#.#.#	...	...

States

	name	description
#.#.#	...	...
#.#.#	...	...
#.#.#	...	...

Modifiers

	name	description
#.#.#	...	...
#.#.#	...	...
#.#.#	...	...

	value	type	description
#.#.#	...	...	...	default
#.#.#	...	...	...	required
#.#.#	...	...	...

Example

{{example image | thumbnail}}

Back to top

Callout examples

Check something out ^r1

Identify a blocker

Add a question / note