Meta:Project AiteStory

From AiteRP Wiki
Revision as of 15:19, 22 September 2017 by Gisle (talk | contribs) (Future)
Jump to: navigation, search

AiteStory is the working title for a project aiming to replace the use cases of the forums that are not covered by this wiki.

AiteStory Concept01.png

The image above is by no means a final design aesthetically, but it shows how the front page will be organized. The single-letters are stand-in for icons. I'd also like feedback on whether (all) the tags should be on the front page.

The project is still in the planning phase. This is an important website, so I'd like to get it right the first time around.

Contributing

Feel free to edit this page to extend the specification, add features, categories and so on. I'm also not much of a designer, so if you have ideas for that or can contribute with graphics I'd really appreciate it.

Goal

The site must accommodate content of the following type.

  • OoC: Announcements, general information, scheduling, etc...
  • Story: Background stories, either from the past or present.
  • Background: RP information about something that may be noticed and acted upon in RP.
  • Document: News stories, text files, messages, etc...
  • Item: Objects relevant to RP, like datapads, OSDs, "loot".
  • Info: Knowledge learned during an event, or just generally things that may be forgotten. That Ilyna left the OSD in the office after her talk with Vasquez could be one such page.

Pages that fit both this site and the wiki should be cross-posted.

Design

The most important aspect of the site's design should be accessibility and readability. Thus, it will be a good old website and not a single-page app like ngn4.io.

Constraints/Goals

  • Page text body should be wide enough for 60 characters, but not wider.
  • Links must be clearly distinguishable from other text formatting
  • Viewing and reading on a handheld device must be comfortable
  • The design should have a Mass Effect theme to it, as long as it does not interfere with other goals
  • All graphical assets should be hosted along with the website. We are currently using less than 0.3% of the upload cap on average, so we have a lot of room for assets.
  • The first visit should not use more than 2 MB of a user's data plan for images, fonts and other cached resources.

Terms

  • Page: The pages are the main pieces of content
  • Category: The type of page, like Info, Item or OoC.
  • Tag: A tag associates a page with a character, location, plot and/or event. They're the blue and orange things in the illustration above.

Features

Minimum Viable Product

The MVP can be deployed to aiterp.net and should only be used for migrating forum content.

  • View list sorted by posting date
  • View page
  • Create page
  • Use markdown formatting
  • Edit page
  • Delete page
  • Filter list based on category
  • Log in using the wiki.aiterp.net account
  • Log out
  • Tag pages
  • Link to pages in IRC, on the wiki and so on

Full Release

The full release is the state at which it is usable for regular RP.

  • Look up pages for a single tag
  • Sort pages by IC date or title
  • Save a page for later publishing
  • Moderate users
  • Moderate pages
  • Moderate tags
  • Link to wiki articles with double-brackets
  • Read-only API for external applications

Future

Features in this category will be implemented, but only after the full release. However, knowing about them now may inform early development and make it easier to implement these in the future.

  • Highlight unread pages
  • Page formats other than markdown, like code and plain text
  • Extend own or others' pages with comments
  • Unlisted pages (e.g. quick copy-pastes and omni-tool messages)
  • Integrate page lists into wiki