75 lines
2.6 KiB
JavaScript
75 lines
2.6 KiB
JavaScript
/**
|
|
* Starting points for a new guide.
|
|
*
|
|
* The blank page is the real barrier to somebody writing a procedure down. A
|
|
* skeleton with the right SHAPE - what you need first, the steps, how you know
|
|
* it worked, what to do when it does not - gets a half-decent guide out of
|
|
* somebody who would otherwise have written nothing.
|
|
*
|
|
* The shape is lifted from the KB articles the team already writes, so guides
|
|
* written here read like the ones written before them.
|
|
*/
|
|
|
|
function id (prefix, n) {
|
|
return prefix + n
|
|
}
|
|
|
|
export const templates = [
|
|
{
|
|
key: 'blank',
|
|
name: 'Blank',
|
|
description: 'Start with nothing',
|
|
blocks: () => [],
|
|
},
|
|
{
|
|
key: 'procedure',
|
|
name: 'Procedure',
|
|
description: 'Before you start, numbered steps, how to check it worked',
|
|
blocks: () => [
|
|
{ id: id('t', 1), type: 'paragraph',
|
|
text: 'What this covers, and when somebody would need it.' },
|
|
{ id: id('t', 2), type: 'callout', variant: 'warning', title: 'Before you start',
|
|
text: 'Anything that has to be true first, or that will bite halfway through.' },
|
|
{ id: id('t', 3), type: 'heading', text: 'Steps' },
|
|
{ id: id('t', 4), type: 'step', title: 'First step', text: '' },
|
|
{ id: id('t', 5), type: 'step', title: 'Second step', text: '' },
|
|
{ id: id('t', 6), type: 'heading', text: 'Check it worked' },
|
|
{ id: id('t', 7), type: 'checklist', items: [
|
|
{ id: id('ti', 1), text: '' },
|
|
{ id: id('ti', 2), text: '' },
|
|
] },
|
|
],
|
|
},
|
|
{
|
|
key: 'troubleshooting',
|
|
name: 'Troubleshooting',
|
|
description: 'Symptom, likely causes, what to check first',
|
|
blocks: () => [
|
|
{ id: id('t', 1), type: 'paragraph', text: 'The symptom, as somebody would describe it.' },
|
|
{ id: id('t', 2), type: 'heading', text: 'Check these first' },
|
|
{ id: id('t', 3), type: 'checklist', items: [
|
|
{ id: id('ti', 1), text: '' },
|
|
{ id: id('ti', 2), text: '' },
|
|
] },
|
|
{ id: id('t', 4), type: 'heading', text: 'Likely causes' },
|
|
{ id: id('t', 5), type: 'table',
|
|
header: ['What you see', 'What it usually means'], rows: [['', '']] },
|
|
{ id: id('t', 6), type: 'callout', variant: 'info',
|
|
text: 'The thing that looks like the cause and is not.' },
|
|
],
|
|
},
|
|
{
|
|
key: 'checklist',
|
|
name: 'Checklist',
|
|
description: 'A list to work through, nothing else',
|
|
blocks: () => [
|
|
{ id: id('t', 1), type: 'paragraph', text: 'When to use this list.' },
|
|
{ id: id('t', 2), type: 'checklist', items: [
|
|
{ id: id('ti', 1), text: '' },
|
|
{ id: id('ti', 2), text: '' },
|
|
{ id: id('ti', 3), text: '' },
|
|
] },
|
|
],
|
|
},
|
|
]
|