Design Document Part 8 (A great small-mid size template)
This is a brilliant example/template you can use for a Design Document (dd). It’s a fantastic example and its downloadable as a word doc.
http://www.jeanpaulva.com/index.php/2011/11/29/low-level-design-document/
Again – in many cases for dd’s this may even to bigger a document (10 pages) than you need, but its certainly similar to a few I have created for a project that is more like 1-4 weeks of work.
Great to see the database design here, because again remember that you want to get feedback for this (particularly from DBA’s, Architects etc…) and getting advice on the DB early is extremely important (DB changes are not always easy).
Design Document Part 7 (template for bigger projects)
I’ve written a lot about Design Documents (dd) recently. This is a great template for a really large project – I’ve never used all of these sections but certainly a number of these categories are useful. It certainly gives you an idea for the scope of what a DD covers.
http://blogs.microsoft.co.il/gadib/2010/10/11/technical-design-document-template/
Just remember the design document is best if it’s as small as you can keep it.
ProcJam – v0.01 effort
Ok so a late decision to enter procjam 2015, and here is my first attempt at producing a PCG generated song. Its about 95% PCG at the moment. I am using Joy Division as my base text resource and have had some great tutorials to work through that gave me a good start:
http://taskproj.com/2014/07/algorithmic-poetry-in-c/
Here’s the first effort – please note that there has been some editing (all stated by the use of{ } and the text inside) and comma’s also inserted:
THIS WAS CREATED BY A C# PROGRAM – WITH A LOT OF HELP FROM IAN CURTIS (RIP), BERNARD SUMNER, PETER HOOK AND STEPHEN MORRIS
FOOTSTEPS
me waiting for something more, as the territories marked
no matter how hard it end where will it
end, where will burn one who goaded you to
give you, you i tried to get to the
power, it’s creeping up just second nature it’s just
second nature it’s just to feel it end, where
will it end where will it end where will
it end where will it end where will it
[CHORUS]
end these are closed, i can do you see
there i can see all true realities, up slowly
that keep your throats wasted, our respect runs so
plain to get to you, i travelled far and step
outside, an angry voice and bent on water run
through fire can’t take much can’t take much can’t
take, good taste of speed, a taste of waste
their eyes tears in a struggle between right {“when”:DELETED}
[CHORUS]
we were young directionless, so plain to you see
there i, did you forget saints with your man
traps with habits of waste their eyes tears, as
the blood on their bodies made a request well
out of the room the one who cried we’ll
share a changeling to watch admire the centre of
sadness for the pleasure, oh i’ve seen the blame
CHORUS:
with no longer the footsteps i’m,
not afraid anymore i’ve seen blood in lime,
changing our time hoping for something
more as the first light starts to sing
fine only stare in the start
of the past stand tall and apart
{two lines of text:DELETED}
iOS developer appletv worldwide talks – SYDNEY 3/2/2016
It’s rare that Apple do worldwide dev tours these days – last time I can remember a session in Australia was like 2008/9 so this is worthwhile.
SYDNEY – 3rd Feb 2016
Sure the focus is AppleTV but for any iOS developer in Australia (or Worldwide) a session like this is worth attending.
Free PCG/Roguelike Resources
A great resource for all sorts of PCG stuff:
ProcJam videos
Procjam 2015
For those interested in a great JAM here is another brilliant comp and a great chance to code for a week a build something cool in the PCG space.
General reminder about a good place to prepare for JAMs like this: roguelikeradio.com check for the episodes in the archives for 7DRL and Procjam
Design Document Part 6 (Another dd found)
OK so here’s another good example and it’s not that’s even called a design document but if it looks like a duck and smells like a duck and quacks – its probably a duck. Same goes here. Look at the section called: The Application Architecture:
http://www.dotnetcurry.com/aspnet-mvc/1199/business-app-html5-aspnet-mvc-webapi-knockoutjs
Design Document Part 5 (seeking feedback)
A little bit of background for the sample design document (dd) I posted in part 4 :
- This dd was used for a hackathon project at my work.
- The original dd was a handwritten 1 page document.
- I did not really get significant review because it was a solo project (normally I wouldn’t do a dd unless I was seeking feedback).
So the last point is the most important – I used this as a sample because it’s easy to post without any real work details. Normally I send these type of documents via email (or at least a link) and ask for feedback. The other option is to do a demo/presentation and just gather the feedback from that session.
So the type of feedback I am after is:
- Am I roughly on the right track?
- Am I using the right frameworks/libraries?
- Am I proposing to re-use any existing patterns or follow approaches (ie. lets not reinvent the wheel).
- DB design/modifications can be tricky and seeking advice from DBA’s for DB changes can be very very useful.
Of course, you need to evaluate feedback sensibly but having your manager involved usually makes that an easier process.