Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Describing and depicting a technical ecosystem #7

Open
AlexanderPico opened this issue Apr 11, 2019 · 0 comments
Open

Describing and depicting a technical ecosystem #7

AlexanderPico opened this issue Apr 11, 2019 · 0 comments
Assignees
Labels
enhance Update existing docmentation from scratch Starting from scratch reporting and metrics Communicating usage and value web site content Content for specific web pages

Comments

@AlexanderPico
Copy link
Member

AlexanderPico commented Apr 11, 2019

Background

The National Resource for Network Biology (NRNB) supports a wide array of network tools and resource, e.g., through programs like Google Summer of Code and Season of Docs. The organization is also responsible for curating an ecosystem of interoperable tools and services centered around Cytoscape and a growing set of web tools.

Cytoscape as a desktop application has been around for ~15 years. In more recent years, we have been diversifying the software and services related to the Cytoscape project. And in just the past couple years, we have shifted time and attention to connecting all of these together in ways that make sense to common usage patterns and enhance the overall project.

Figuring out how to communicate each of the components and how they ineract has proven very difficult for our dev team. But we are motivated to address the confusion among both users and other stakeholders.

Below are some of the pages that describe the "laundry list" of tools and services that relate to Cytoscape and are directly under the umbrella of the National Resource for Network Biology (NRNB).

We also have a collection of 6 or so diagrams where we are attempting to illustrate the ecosystem. Currently, these are in draft form and not publically accessible, but we would share them immediately with interested tech writers.

Goals

  • A narrative description of the NRNB's Ecosystem of tools and services. There are multiple "spheres" of inclusion in this ecosystem; the boarder is blurry. There are also multiple audiences, including funders, developers and end-users/researchers. We have some draft text we can share from a recent grant application.
  • A graphical representation of the ecosystem, e.g., one or more diagrams with a consistent visual lexicon. We have some draft figures we can share from a recent grant application.
  • Tailored language and graphics for particular audiences and contexts, e.g., specific landing pages vs "about" pages vs official reports vs slideshow presentations, etc.
  • Input from a professional on a successful strategy for developing these descriptions, e.g., should we make a "mega" figure and description and chop it up per audience and usage, or should we make separate figures and descriptions? How do other orgs do this?

Technical Skills

  • Experience describing desktop and web tools, services and resources (must have)
  • Experience with complex technical ecosystems (nice to have)

Links

Potential Mentors

Alex Pico

Contact

Alex Pico

@AlexanderPico AlexanderPico added enhance Update existing docmentation from scratch Starting from scratch web site content Content for specific web pages reporting and metrics Communicating usage and value labels Apr 11, 2019
@AlexanderPico AlexanderPico self-assigned this Apr 11, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhance Update existing docmentation from scratch Starting from scratch reporting and metrics Communicating usage and value web site content Content for specific web pages
Projects
None yet
Development

No branches or pull requests

1 participant