Create and update 'detailed guide: detailed guide' on GOV.WALES

Before you create or edit content, you need to read and understand:

• the style guide
• writing for GOV.WALES

You should also have a version of the content ready for publication. A detailed guide: detailed guide will usually be split into sections with headings.

Use for:

• answering specific, task-oriented user needs
• guidance the government has a duty to provide, not general advice
• providing information that a user needs to understand and contextualise future tasks
• specialists or professionals usually (consider a guide for less detailed content intended for the general public)

Use this format for content that is regularly updated, for example if the process to complete a task changes.

If your content does not fit the criteria, you’ll find that it is most likely a:

• policy paper or policy supporting detail
• document collection
• guidance publication

Do not use:

• for giving general advice
• for explaining government policy
• as a last resort for content that does not fit into other format types

Creating a new detailed guide: detailed guide

1. Log in to GOV.WALES and LLYW.CYMRU.
2. Select the Workbench view in GOV.WALES (you must start on the English site).
3. Select Create content.
4. Select Detailed guide.
5. Select Detailed guide from the Detailed Guide field.
6. Complete the Title field.
7. Complete the Summary field.
8. If you want to split your content into sections, select Add Content Section.
9. Complete the Section title field.
10. Select Add Content and paste content into the Content field.
11. If you want to add more content sections, repeat steps 7 to 9.
12. Tag to relevant Topics.
13. If content is from or about an organisation complete EXTERNAL ORGANISATIONS with the name of the organisation.
14. Add up to around 5 INTERNAL LINKS (NODE) to content directly related to the users needs being met by the detailed guide: detailed guide.
15. Do not usually complete INTERNAL LINKS (TERMS). Either the detailed guide: detailed guide is relevant to a topic therefore tagged to it or linked to pages meeting specific user needs.
16. To link to another website select Add External Link.
17. Select Save and Create New Draft.
18. To add the Welsh content, select TRANSLATE.
19. Select Add from row labelled Welsh.
20. Update fields with Welsh language content.
21. To save changes without making them public select Save and Create New Draft. (this translation). To save and make changes public select Save and publish (this translation).
22. Publish the Welsh and the English and check both languages, for example layout is correct and links work.

Editing an existing detailed guide: detailed guide

1. Find the existing detailed guide: detailed guide either by browsing the public site or select Workbench then All recent content. You must do this on GOV.WALES as the English content must be edited first.
2. Open the detailed guide: detailed guide.
3. Select EDIT DRAFT or NEW DRAFT.
4. Edit the detailed guide: detailed guide.
5. Complete Revision log message (all languages) with brief summary of changes.
6. To save changes without making them public select Save and Create New Draft (this translation). To save and make changes public select Save and publish (this translation).
7. Make the same changes to the Welsh version of the detailed guide: detailed guide.

Lists which components are available and how to use them if they are allowed.

Paragraphs: content section

Use the content section paragraph to break up longer pages with headings.

Paragraphs: content

You must use the content paragraph for the majority of the page content.

Paragraphs: accordion

Follow the accordion definition to add an accordion. 

Paragraphs: related links

Follow the related links definition to add related links.

Paragraphs: call out message

You may only use the following call out messages on detailed guide: detailed guide:

• other
• information

Paragraphs: contact details

Follow the contact details definition to add contact information, for example a telephone number.

Paragraphs: launcher

Do not use the launcher paragraph on a detailed guide: detailed guide.

Paragraphs: iFrame

Use only to embed a YouTube video.

Internal links (node)

Use to link to around 5 pages directly related to the users needs being met by the detailed guide: detailed guide.

Internal links (terms)

Avoid using internal links (terms). These links are to topics and usually the most relevant topic is already found by the breadcrumb.

External links

Follow the sidebar links definition to link to content directly related to the user needs met by your content.