Skip to content

Commit

Permalink
add definition of "spike" with section sub-header so we can *link* to…
Browse files Browse the repository at this point in the history
… it. resolves #40
  • Loading branch information
nelsonic committed Jun 17, 2022
1 parent e613173 commit b207562
Showing 1 changed file with 45 additions and 3 deletions.
48 changes: 45 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,23 @@
<div align="center">

# Technical Glossary

This glossary is ever-evolving and relies on the contributions of people like
you for new word suggestions :heart:. If you've got a word you'd like a definition
please create an issue: [github.com/dwyl/technical-glossary/issues/](https://github.com/dwyl/technical-glossary/issues/new)
This glossary is ever-evolving
and relies on the contributions
of people like _you_
for new word suggestions ❤️.
If a technical term you
would like a definition for,
please create an issue:
[github.com/dwyl/technical-glossary/issues/](https://github.com/dwyl/technical-glossary/issues/new)

[![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat-square)](https://github.com/dwyl/technical-glossary/issues)
[![HitCount](http://hits.dwyl.com/dwyl/technical-glossary.svg)](http://hits.dwyl.com/dwyl/technical-glossary)

</div>

### Why?

Have you ever learnt something cool in coding without knowing what it's actually
called? Or have you ever been reading about a concept only to get lost in the
number of acronyms and other technical words used to describe what you're
Expand Down Expand Up @@ -238,6 +251,35 @@ describe what they contain/are being used for E.g. a `<p>` tag indicates that th
text within it is a paragraph whereas a `<nav>` tag should contain navigation
content and a `<footer>` should appear at the end of the page.

### Spike

A **spike** is a product development method
that uses the **_simplest_ possible experiment**
to explore potential solutions.
It can be just a basic design/interface test (wireframe)
or a technical exploration often called a proof of concept (POC).
See: https://en.wikipedia.org/wiki/Spike_(software_development)

**`@dwyl`** our **spike** mini-projects
are usually **time-boxed**
anything from an hour to a day of effort.
The **objective** is to **capture the _learning_**
as much as it is to test the interface or technical implementation.
Therefore we always create a new GitHub repo to _capture_ the experiment.
Sometimes we will include the word "spike" in the repo,
e.g: https://github.com/dwyl?q=spike
Other times, we will _expand_ the repo into an **_example_ app**
that is more of a **tutorial** that _anyone_ can follow,
e.g: https://github.com/orgs/dwyl/repositories?q=example

However much detail you include in your spike,
remember that the objective of the experiement is
_communicating_ what you tried.
It's not enough for _you_ to know that it worked (or failed),
you need to **share _everything_ you learned** along the way.



**Syntactic Sugar** - syntactic sugar refers to syntax in a language that is
designed to make things easier to read. The syntax makes the language "sweeter"
to use as things can be expressed more clearly or concisely. Something can be
Expand Down

0 comments on commit b207562

Please sign in to comment.