Work in progress
From SKYbrary Wiki
Revision as of 13:58, 10 September 2018 by Editor1
First read the article [[Writing a SKYbrary Article]. This article is intended as a deeper and more pragmatic discussion regarding writing conventions, the structure of articles and some tips and example code that will be useful when writing SKYbrary articles.
If the title of an article is to include a commonly recognised abbreviation, always include the full name and add the abbreviation in brackets afterwards, e.g. Instrument Landing System (ILS).
The title of an article should reflect the terminology in use in Europe. Differences in terms between North America and Europe/Rest of World are addressed by ensuring that the North American terms are referred to in the body of the text - this way they will be picked up by search engines. For example take a look at the article on Level Bust; in this case the North American term is highlighted at the top of the article in a larger font like this:
This isn't absolutely necessary - the important thing is to endsure that alternative recognised terminology is referred to at some ;point in the main body text, usually within the Description.
Articles addressing an operational risk should conform to the same generic layout as shown in the exemplar article on Jet Stream. For other articles however, this may not be appropriate. In such cases, the article should always start with a Definition and/or a Description in which you explain what the article is about and also, where appropriate, what it is not about. The main body should then be structured in a logical way finishing with Related Articles (internal links) and Further Reading (external links and Bookshelf items).
Style and Language
SKYbrary articles are closer to an Encyclopaedia entry than a magazine article. The article must avoid references to future events as this makes the article look dated when viewed after those events have taken place. Article are written in UK English.
Accidents and Incidents
Any use of a previous accident or incident, to illustrate a safety point, must link to an existing event in SKYbrary's A&I event database. If the perfect illustration of a safety issue is an event currently not included in the database then a request should be made to the Content Manager to have the event included in the Database (this could take 3 months).
It is often very useful to include a dynamic query that will list all events in the SKYbrary A&I database that are tagged with a relevant tag. e.g. a list of all events that tagged as Overrun on Take Off
- CL60, Teterboro USA, 2005 (On 2 February 2005, a Challenger, belonging to Platinum Jet Management, crashed after taking off from Teterboro, New Jersey, USA. The aircraft's center of gravity was well forward of the forward takeoff limit.)
- B732, Pekanbaru Indonesia, 2002 (On 14 January 2002, a Boeing 737-200, operated by Lion Air, attempted to complete a daylight take off from Pekanbaru, Indonesia without flaps set after a failure to complete the before take off checks. The rejected take off was not initiated promptly and the aircraft overran the runway. The take off configuration warning failed to sound because the associated circuit breaker was so worn that it had previously auto-tripped and this had not been noticed.)
- DC86, Manston UK, 2010 (On 11 August 2010, a Douglas DC8-63F being operated by Afghanistan-based operator Kam Air on a non scheduled cargo flight from Manston UK to Sal, Cape Verde Islands failed to get airborne until after the end of departure runway 28 during a daylight take off in normal visibility. The aircraft eventually became airborne and climbed away normally and when ATC advised of the tail strike, the aircraft commander elected to continue the flight as planned and this was achieved without further event. Minor damage to the aircraft was found after flight and there was also damage to an approach light for the reciprocal runway direction.)
A lists of events that accompany each Category e.g. Accident and Serious Incident Reports: AW is an easy source of the code needed to set up a query. More sophisticated queries are possible e.g. that show a particular kind of event that occurred in a specific phase of flight.
Images on SKYbrary are presented in the following way:
When uploading images, ensure that the size of the image is below 1mb in size.
Constructing tables is complex and takes a certain amount of patience. Here is an example of a tables whose code can be used as a template:
|A (a)||· −||B (b)||−· · ·||C (c)||−· −·||D (d)||−· ·|
|E (e)||·||F (f)||· ·−·||G (g)||− −·||H (h)||· ·· ·|
|I (i)||· ·||J (j)||· − − −||K (k)||− · −||L (l)||· − · ·|
|M (m)||−−||N (n)||−·||O (o)||− −−||P (p)||· −−·|
|Q (q)||−−· −||R (r)||· −·||S (s)||·· ·||T (t)||−|
|U (u)||·· −||V (v)||· · · −||W (w)||· − −||X (x)||− · ·−|
|Y (y)||−· − −||Z (z)||−−· ·|
|1||· − −−−||2||·· −−−||3||· ·· −−||4||··· · −|
|5||· · · · ·||6||−· · · ·||7||− −· · ·||8||− −−· ·|
|9||− −−−·||0||− −−−−|
|Period [.]||·− ·− ·−||Comma [,]||− − ··− −||Question [?]||· · − −· ·||Exclamation [!]||·− ·− − −|
|Parenthesis Open [(]||− ·− − ·||Parenthesis Close [)]||−·− − ·−||Colon [:]||− − −· · ·||Semi Colon [;]||− · − ·− ·|
|Start||−· −· −||End of Work||· · · −· −||New Page||· −· −·||Wait||· −· · ·|
|Understood||· · · −·||Error||· · · · · · · ·|