Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions _compress_images_cache.yml
Original file line number Diff line number Diff line change
Expand Up @@ -362,9 +362,9 @@ assets/images/guide/glossary/descriptors-mobile.jpg: descriptors-mobile.jpg
assets/images/guide/glossary/descriptors.jpg: descriptors.jpg
assets/images/guide/glossary/[email protected]: [email protected]
assets/images/guide/glossary/[email protected]: [email protected]
assets/images/guide/resources/resources-preview.jpg: resources-preview.jpg
assets/images/guide/resources/formatting-preview.jpg: formatting-preview.jpg
assets/images/guide/resources/content-guidelines-preview.jpg: content-guidelines-preview.jpg
assets/images/guide/contribute/resources-preview.jpg: resources-preview.jpg
assets/images/guide/contribute/formatting-preview.jpg: formatting-preview.jpg
assets/images/guide/contribute/content-guidelines-preview.jpg: content-guidelines-preview.jpg
assets/images/submit-header-design-preview.jpg: submit-header-design-preview.jpg
assets/images/projects-preview.jpg: projects-preview.jpg
assets/images/search-preview.jpg: search-preview.jpg
Expand Down
62 changes: 62 additions & 0 deletions guide/contribute/content-guidelines.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
---
layout: guide
title: Content guidelines
description: Writing tips for authors of the Bitcoin Design Guide.
nav_order: 10
parent: Contribute
permalink: /guide/contribute/content-guidelines/
image: /assets/images/guide/contribute/content-guidelines-preview.jpg
---

# Content guidelines

The Bitcoin Design Guide is the work of many authors with different backgrounds, each with their own unique voice and perspective. To help us ensure a consistent written voice throughout the guide, follow these content guidelines.

#### Know your reader

This guide is crafted for anyone interested in building an effective Bitcoin application. Read more in-depth about the [Target audience]({{ '/guide/target-audience' | relative_url }}).

#### Speak to the reader

Address the reader directly. Whenever possible, try using active instead of passive voice. Make reader a part the conversation by using second-person pronouns like "you, your and yours". Do not write in first-person and avoid giving predictions and personal opinions.

#### Use simple language

Bitcoin is a global currency. Not everyone using this guide is a native English speaker. Make sure you are writing in plain, easy to follow English. If you're still not sure, try using a readability tool to analyze your text and make recommendations. We like [Hemingway](http://www.hemingwayapp.com).

#### Be concise

Focus on information relevant to the reader. Use direct, clear, concise sentences that are easy to understand. Try to reduce the word count to just the right brevity without being obscure.

#### Make content scannable

On the internet, majority of people scans the content before reading it. By scanning, a reader tries to search for relevant information on the page.
Split text into paragraphs, use links, text styling and images to enhance the scanability. Per paragraph, you should have 3-4 sentences.

#### Linking

Linking provides necessary context and helps avoid information repetition. Link to the [Glossary]({{ '/guide/glossary' | relative_url }}) or to another page in the guide whenever possible. If information isn't available, consider linking to a reputable third-party resource.

#### Give tips, not commands

When giving instruction, stick to broad strokes. They can be adjusted over time to grow with a project and its designer. Overly detailed instructions are usually outdated by the next software patch.

#### Get the reader involved

The Design Guide is a set of recommended solutions and practices based on our research that should encourage self-sufficient thinking and creativity. Motivate people to think critically and inspire them to come up with their own solutions.

#### Show, don’t tell

When it's possible, try to provide an example or a visual instead of highly-technical explanation. Feel free to reference other software using screenshots. Remember to indicate the product and version. Focus on what you like about them instead of what you don't like.

#### Use the right medium

A picture is worth a thousand words, but so are videos, interactive prototypes, diagrams, and more. Don't be afraid to try a different medium if you think it will inform better than text or a picture. If you'd like to help us create this kind of content, visit https://bitcoin.design/ and join our Slack.

#### Be humble

The guide is a work in progress and needs to evolve to stay relevant. What we write today may not be applicable tomorrow. Have fun. Don't overthink things. Bitcoin, and therefore this guide, is the ultimate work-in-progress.

#### Write in the open

It's a good idea to ask for directions by seeking feedback early. This may stop you from wandering too far in the wrong direction. There is a whole community around you that's ready to jump in and help.
10 changes: 5 additions & 5 deletions guide/resources/formatting.md → guide/contribute/formatting.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@ layout: guide
title: Formatting
description: Visual examples of formatting options available for content authors.
nav_order: 11
parent: Resources
permalink: /guide/resources/formatting/
image: /assets/images/guide/resources/formatting-preview.jpg
parent: Contribute
permalink: /guide/contribute/formatting/
image: /assets/images/guide/contribute/formatting-preview.jpg
---

# Formatting
Expand Down Expand Up @@ -182,7 +182,7 @@ Let's start with a very wide image that extends beyond the content with on deskt
layout = "float-left-desktop"
%}

Mobile app stores do a good job at providing previews of what using an app will be like. Through copy, videos, images and reviews, users can make informed decisions about the product they are evaluating. Open-source software is typically downloaded via a website or from Github and each project decides what information to present.
Mobile app stores do a good job at providing previews of what using an app will be like. Through copy, videos, images and reviews, users can make informed decisions about the product they are evaluating. Open-source software is typically downloaded via a website or from Github and each project decides what information to present.

</div>

Expand All @@ -199,7 +199,7 @@ Mobile app stores do a good job at providing previews of what using an app will
layout = "float-left"
%}

Mobile app stores do a good job at providing previews of what using an app will be like. Through copy, videos, images and reviews, users can make informed decisions about the product they are evaluating. Open-source software is typically downloaded via a website or from Github and each project decides what information to present.
Mobile app stores do a good job at providing previews of what using an app will be like. Through copy, videos, images and reviews, users can make informed decisions about the product they are evaluating. Open-source software is typically downloaded via a website or from Github and each project decides what information to present.

</div>

Expand Down
29 changes: 29 additions & 0 deletions guide/contribute/introduction.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
layout: guide
title: Contribute
description: Additional material for both readers and writers of the guide.
nav_order: 11
has_children: true
permalink: /guide/contribute/
image: /assets/images/guide/contribute/resources-preview.jpg
---

# Contribute to the Bitcoin Design Guide

People around the internet build and shape the Bitcoin Design Guide every day. You can be the part of our open-community too!

This page shows you how to get involved and start contributing.

---

**[Content guidelines]({{ '/guide/contribute/content-guidelines/' | relative_url }})**

Tips on how to write for the guide, with the goal of achieving a consistent tone across all pages.

---

**[Formatting]({{ '/guide/contribute/formatting/' | relative_url }})**

Layout and formatting options available for content pages, from headers and blockquotes to images and embeds.

Bitcoin Design Guide is just a project within the Bitcoin Design community. To get involved with the broader Bitcoin-Design community and projects, check out [general contribution guidelines](https://bitcoin.design/contribute/).
55 changes: 0 additions & 55 deletions guide/resources/content-guidelines.md

This file was deleted.

25 changes: 0 additions & 25 deletions guide/resources/resources.md

This file was deleted.