Writing Articles
- 11 Jul 2024
- 2 読む分
- 印刷する
Writing Articles
- 更新日 11 Jul 2024
- 2 読む分
- 印刷する
The content is currently unavailable in Ja - 日本語. You are viewing the default English version.
記事の要約
この要約は役に立ちましたか?
ご意見ありがとうございます
Generally articles should be kept instructional and not conversational. Try to keep articles short and to the point.
There is a 'Dise General Guide' template that can be used to help start writing an article. Found in 'Content tools>Templates'.
Things to consider:
- Most of the article should be in bullet/numbered format.
- Don't use conversational language - "We", "you", "first we do this", "this article is going to teach you", etc.
- Try and restrict the amount of images used in an article.
- Keep titles to the point.
- There's no need to repeat what's in the title - 'Create a display' article doesn't need another 'Create a display' title in the article or to say things like 'This is how to create a display'.
- Try not to use external URLs as we don't control these. For example, just instruct to 'download the latest software from the providers website'.
- Use American spelling (more international).
Start writing the article:
- Start with a short introduction to the article. Some simple articles don't need an intro but others may need 1-2 sentences to explain the feature.
- Use numbered lists to instruct what to do, keeping the instruction as short as possible without missing info. If the instruction is getting to long, maybe split it across multiple steps.
- Use 'Heading 2' to split the article into sections. Heading 2 is what shows on the table of contents.
- Split sections of the article with the line (select the 3 dots in the top bar).
- Use other headings for sub sections (don't divide these with a line).
- Any large images should be 500px wide (leave height as auto). Enable all style options.
- Smaller images should be in line and centered so it sits at the end of a sentence. These images should be anywhere between 25px-150px wide depending on how it looks on the article page. Copy the magnifying icon from another article next to the small image. Enable rounded and bordered style options.
- Use the numbered dots in the doc360 drive (My drive -> Dise -> Articles) on images that have multiple steps linked to it. Use paint or some other editing software to add the dots to the image in the correct place (dots should be 40px x 40px).
- Change the color of hyperlinks to #2C82C9.
Use the yellow callout to highlight notes or warnings that users should pay special attention to. Remove the 'content goes here' in the code of the page (located top right next to the undo button)
Your content goes here
Example:
Use the blue callout for any examples.
この記事は役に立ちましたか?