diff --git a/_compress_images_cache.yml b/_compress_images_cache.yml index 4033da5a8..fe4d7912d 100644 --- a/_compress_images_cache.yml +++ b/_compress_images_cache.yml @@ -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/wallet@2x.jpg: wallet@2x.jpg assets/images/guide/glossary/descriptors@2x.jpg: descriptors@2x.jpg -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 diff --git a/guide/contribute/content-guidelines.md b/guide/contribute/content-guidelines.md new file mode 100644 index 000000000..02e43eaf1 --- /dev/null +++ b/guide/contribute/content-guidelines.md @@ -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. diff --git a/guide/resources/formatting.md b/guide/contribute/formatting.md similarity index 98% rename from guide/resources/formatting.md rename to guide/contribute/formatting.md index 5f0719856..21f3694b7 100644 --- a/guide/resources/formatting.md +++ b/guide/contribute/formatting.md @@ -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 @@ -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. @@ -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. diff --git a/guide/contribute/introduction.md b/guide/contribute/introduction.md new file mode 100644 index 000000000..069d902e4 --- /dev/null +++ b/guide/contribute/introduction.md @@ -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/). diff --git a/guide/resources/content-guidelines.md b/guide/resources/content-guidelines.md deleted file mode 100644 index b7c9eefe6..000000000 --- a/guide/resources/content-guidelines.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -layout: guide -title: Content guidelines -description: Writing tips for authors of the Bitcoin Design Guide. -nav_order: 10 -parent: Resources -permalink: /guide/resources/content-guidelines/ -image: /assets/images/guide/resources/content-guidelines-preview.jpg ---- - -# Content guidelines - -The Bitcoin Design Guide is the work of many authors from many 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 was created specifically for designers who work on open-source, non-custodial bitcoin projects. It isn't the biggest audience in design, but it is among the most specialized. - -#### Use simple language - -Bitcoin is a global currency, so not everyone using this guide will be a native English speaker. Make sure you are are writing 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 precise - -Focus on what's most useful to your reader. If you suspect that something isn't working, it probably isn't. If a page or a paragraph gets too long, split it up. If you want users to dive deeper into a topic that is not essential to the guide, consider linking to a third-party resource. - -#### Speak to the reader - -Address the reader directly and make them a part of the conversation by using second-person pronouns like "you," "your," and "yours." - -#### 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 - -Consider asking questions before giving answers. This encourages self-sufficient thinking that will benefit readers more than cutting straight to the chase. You can also add work-sheets, to-do lists, do's and don'ts, and other instructive examples. - -#### 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. - -#### Show examples - -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. - -#### 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. - - diff --git a/guide/resources/resources.md b/guide/resources/resources.md deleted file mode 100644 index 440e16075..000000000 --- a/guide/resources/resources.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -layout: guide -title: Resources -description: Additional material for both readers and writers of the guide. -nav_order: 11 -has_children: true -permalink: /guide/resources/ -image: /assets/images/guide/resources/resources-preview.jpg ---- - -# Resources - -This section includes additional materials for both readers and writers of the guide. - ---- - -**[Content guidelines]({{ '/guide/resources/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/resources/formatting/' | relative_url }})** - -Layout and formatting options available for content pages, from headers and blockquotes to images and embeds.