Skip to content

Holistic guide review #202

Closed
Closed

Description

@GBKS

General review of the guide:
- Cross-linking
- Proof-reading (grammar, typos)
- Proof-reading (does it make sense)
- Consolidate

Activity

  1. added
    CopyTask is about improving text.
    on Mar 29, 2021
  2. added this to the Sprint #3 milestone on Mar 29, 2021
  3. danielnordh commented on Apr 16, 2021

    @danielnordh
    Contributor

    WIP - Review dump (content / structure)
    (will organize and tackle actions later)

    • bitcoin.design
      • Guide is not very prominent (Slack, Github, bitcoin.org all more prominent), Assume most visitors will want to consume content before contributing or joining slack to ask questions
      • Add Guide button among Slack/Github buttons? Replace Github, Revise call-to-actions on the home page #328
      • Remove link to bitcoin.org in subtitle
    • bitcoin.design/guide
      • Reduce height of header image? (takes up a lot of space, taller than most other headers)
      • Tweak wording, feels a bit clunky and long, get straight to the content instead about talking about 'the guide project'
      • More focus on the chapter list (bigger styling?)
      • Be mindful that PR Update guide.md #220 updates this text (now merged)
    • bitcoin.design/guide/getting-started/
      • Shorten intro text
      • Feels like a lot of content to get through when looking at the subpages list
      • lowercase bitcoin in sidenav 'Why bitcoin is unique'
      • Review description of each subpage and see if core points can be incorporated (to potentially deliver 80% of the value of the chapter on this one page?)
      • Why design for bitcoin (do we need to convince people if they have managed to find this page?)
        • Be on the cutting edge / Blaze the trail, can these be combined? feel similar
      • Open design is a good page but does a reader really need to get through this before learning about bitcoin? (move?)
      • 'Personal finance' -> 'Personal finance and use cases'? (Link to case studies from the different use cases?)
      • Is User research page needed here / in the right place (has some unique things for bitcoin but most is not specific to bitcoin?)
      • Visual language
        • Unicode symbol - 'few fonts support...' mention Inter / other efforts to increase support?
      • Usage life-cycle is a good page, but has no bitcoin-specific info, cut/move?
      • Common user flows
        • shorten intro text
        • 'Orientation' -> 'Awareness' ?
        • Onboarding - link to onboarding section
        • Creating a new wallet - mention common pk management schemes (link)
        • Securing a wallet - mention helping the user with backups (link)
        • Send bitcoin - show mobile example as well / instead of desktop
        • Receiving bitcoin - 'knowing when HAS BEEN sent and confirmed', missing words
        • 'Switch wallets' -> 'Migrate wallets' (import/export?)
        • Wallet maintenance - doesn't mention what might be required (oh, it does, but subheading is almost indistinguishable plus has the same size/type icon)
      • Technology primer
        • Bitcoin or bitcoin - explain Capitalized first to be consistent with subheading
        • 'Addresses are generated on your own computer', make less specific to include mobile etc., mention HD wallets / many under one master key?
      • Split 'Getting started' in two? -> Getting started with Bitcoin / Designing bitcoin products, Splits pages from "Getting started" into "Designing Bitcoin products" section #333
        • Getting started with Bitcoin
          • Why Bitcoin is unique
          • Visual language
          • Technology primer
          • Software overview
          • Hardware overview
        • Designing Bitcoin products
          • User research
          • Usage lifecycle
          • Personal finance
          • Common flows
    • bitcoin.design/guide/onboarding/
      • Shorten intro text
      • List subpages (while WIP / as coming soon)
      • Getting to know your users
        • How does use-case play into this? Users to 'observe' will be different depending on case
    • bitcoin.design/guide/private-key-management
      • Typo, missing space after 'private key' link in intro paragraph
      • Remove 'Case studies' from intro page, no longer in chapter --> PR Remove case studies from pkm introduction page #259 (merged)
      • Private key schemes
        • Use case, link to 'Personal finance' page in Getting started --> PR Remove case studies from pkm introduction page #259 (merged)
        • Separate between software / hardware wallets in 'Recovery-phrase' schemes? (illustrations)
        • Or rather, clarify naming of 'External signing device' -> Manual backup / Software wallet vs Hardware wallet
        • Multi-key might not be the only option for multi-user (couples can use single-key with multiple hardware wallets)
        • Shade/color scheme boxes in illustrations to separate from other boxes
        • Change flowchart to use Personal/Shared instead of individual/multi-user
      • Personal schemes
        • Consider Manual backup / Recovery phrase vs External signing device (As above, software vs hardware...)
        • Automatic cloud backup has pros/cons section twice
      • Shared schemes
        • Add shared single key scheme (using same key on two wallet apps, software or hardware)

    General thoughts

    • Replace 'non-custodial' throughout with 'self-custody' ?
    • We should have descriptions / links to 'reference setups' for common situations (software wallet + backup, hardware wallet + backup, multi-sig + backup etc.)

    (to be continued)

  4. modified the milestones: Sprint #3, Sprint #4 on Apr 19, 2021
  5. johnsBeharry commented on May 13, 2021

    @johnsBeharry
    Contributor

    From @Bosch-0 in #240

    say native segwit instead of just segwit (segwit is written in all lower case also https://github.com/bitcoinops/bitcoinops.github.io/blob/master/STYLE.md)

  6. removed this from the Sprint #5 milestone on Jun 7, 2021
  7. pavlenex commented on Jun 7, 2021

    @pavlenex
    Contributor

    I feel like we can close this issue as it's quite broad. We can open up issues per page/chapters to have a more focused to-do.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

CopyTask is about improving text.

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions