Giter VIP home page Giter VIP logo

sketch-user-flow-docs's Introduction

Sketch User Flows

This plugin exports every artboard in your design document and allows you to create a user flows document for clients by populating a template.

  • Export for User Flows (⌃⇧E)
  • Populate User Flows (⌃⇧P)

Installation

  1. Download the repository using this link
  2. Unzip the files from the ZIP
  3. In Sketch 3, select Plugins > Reveal Plugins Folder... from the menu bar
  4. Put the (downloaded, unzipped) folder in here

Setup

In your visual design document...

  • Pages should be given a number and title separated by a space e.g.:
    • 01 Welcome
    • 02 Signin
  • Artboards should have a number and title separated by a space e.g.:
    • 02.1 Sign in
    • 02.2 Sign in success
    • 02.3 Sign in failure
  • To hide a page or artboard, start the name with an underscore (e.g.):
    • _01 Welcome
    • _02.1 Sign in
  • Add a text layer named User Flow Description to each artboard (screen) where you want a description in the user flow doc (you can hide this text layer if you like)

Usage

  1. Run the Export for User Flows plugin (⌃⇧E)
  2. Fill in the project name and version number
  3. Create a new User Flow doc by going File > New From Template > Ribot Visual Doc iPhone 6
  4. Run the Populate User Flows plugin (⌃⇧P)
  5. Save your User Flow doc

Compatibility

Tested on Sketch 3.3 and 3.4

Licence

Copyright 2014 ribot

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

sketch-user-flow-docs's People

Contributors

matt-oakes avatar anucreative avatar

Watchers

James Cloos avatar Mint Sansern Wuthirat avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.