documentation   102299

« earlier    

Game Design Docs II
In the last post, I talked a bit about my game design documents for Vespers, although technically they’re really more like level design documents. Vespers doesn’t have levels, of course, but it does have Acts that are organized chronologically, so design docs for each Act help to organize the content and action into discrete compartments. I thought this would be an interesting look at how the game is structured, where the action takes place, and how the docs have helped in the design and development of the game.
gamedesign  documentation 
39 minutes ago by DirkSonguer
Webpack Plugin Documentation
This is from version 1 of the documentation.
webpack  plugin  documentation 
4 hours ago by brunsnik
Designing better file organization around tags, not hierarchies
Excerpts from introduction:
"Computer users organize their files into folders because that is the primary tool offered by operating systems. But applying this standard hierarchical model to my own files, I began to notice shortcomings of this paradigm over the years. At the same time, I used some other information systems not based on hierarchical path names, and they turned out to solve a number of problems. I propose a new way of organizing files based on tagging, and describe the features and consequences of this method in detail.

Speaking personally, I’m fed up with HFSes, on Windows, Linux, and online storage alike. I struggled with file organization for just over a decade before finally writing this article to describe problems and solutions. Life would be easier if I could tolerate the limitations of hierarchical organization, or at least if the new proposal can fit on top of existing HFSes. But fundamentally, there is a mismatch between the narrowness of hierarchies and the rich structure of human knowledge, and the proposed system will not presuppose the features of HFSes.
existing alternative systems like Git and Danbooru bypass HFS problems to deliver a better user experience. Then I describe a step-by-step model, starting from basic primitives, of a proposed file organization system that includes a number of desirable features by design.
I care most about the data model and less about implementation details. For example in HFSes, I focus on the fact that the file system consists of a tree of labeled edges with file content at the leaves; I ignore details about inodes, journaling, defragmentation, permissions, etc."

Corresponding community discussion:

Startupinthecloud  File  Filesync  semanticweb  knowledgemanagement  Enterprise_Architecture  Data  Data_Warehouse  Tutorial  Documentation  Education  Report  Innovation  community  Database 
11 hours ago by eocas
Jacob Kaplan-Moss
I love Django’s documentation. It clocks in at about 700 pages printed, and most of it is clear, concise, and helpful. I think Django’s among the best documented open source projects, and nothing makes me prouder.</i></p>\n<p><i>If any part of Django endures, I hope it’ll be a sort of “documentation culture” — an ethos that values great, well-written documentation. To that end, I’m writing a series of articles laying out the tools, tips, and techniques I’ve learned over the years I’ve spent helping to write Django’s docs.</i></p>\n<p><i>This advice will mostly be targeted towards those documenting libraries or frameworks intended for use by other developers, but much of it probably applies to any for of technical documentation.
documentation  howto  writing  programming 
15 hours ago by DirkSonguer

« earlier    

related tags

account  accounts  acknowledgement  admin  administration  advice  alternate  api  apple  arduino  asciidoc  audio  awesome  aws  bestpractice  bestpractices  biography  bluepay  book  bootstrap  build  business  bytecode  campaigns  card  cards  change  check  cheque  classification  cli  client  code  collaboration  command  comment  community  complexity  compliance  components  condition  conditional  configuration  configure  connecting  constituent  content  coordinator  create  credit  crm  css  custom  dash  data  data_warehouse  database  dataprotection  default  deferred  demo  design  designpatterns  dev  development  devops  diagram  disable  docker  docs  donation  donations  download  draw  drawing  duplicate  edit  education  email  emails  enter  enterprise_architecture  esp8266  example  examples  exit  file  filesync  form  format  forms  freebsd  fundraising  funds  gamedesign  games  gateway  gdpr  generator  getting  git  gitlab  guide  handbook  helm  highlight  howto  html  humor  iam  ico  infosec  init  innovation  issue  javascipt  javascript  js  json  k8s  kit  knowledge  knowledgemanagement  later  latex  less  lesskey  levels  library  lightspeed  linking  linux  lisp  login  man  management  manually  manuals  markdown  media  messages  ms_access  nas  neon  neoncrm  npm  ocaml  ontology  organization  override  overview  page  pages  patternlibrary  pay  payment  payments  people  plugin  policy  portal  presenter  programming  prosopography  publishing  python  quantum  qxs  rack  rdf  react-router  react  reactjs  records  recurring  reference  relationship  report  resource  response  roman  rust  sandbox  scm  scratch  script  secure  security  semanticweb  server  services  set  settings  shopify  sit  social  software  source  split  standard  started  startup  startupinthecloud  stream  style  styleguide  support  survey  syntax  sysadmin  system  systems  tagging  team  template  termcap  terraform  test  thank  theme  themekit  tolearn  tool  tools  toread  totry  tounderstand  track  tracking  trading  transaction  transactional  tutorial  tutorials  tweet  twitter  uk  update  upload  user  versions  vue  waf  web  webdev  webpack  website  wiki  windows  work  writing  you  zfs   

Copy this bookmark: