Dash tar koddokumentation till Mac-skrivbordet

Om du är programmerare, lita du redan på dokumentationen. Dash (gratis, $ 19,99 för full version) är en Mac-app som är utformad för att göra din nödvändiga läsning en mer trevlig upplevelse.

De flesta programmörer känner inte till sitt föredragna språk av val inom inuti. Ännu färre skryta med en detaljerad kunskap om varje bibliotek och API som de kommer i kontakt med. Som programmerare vi Google. Vi frågar Stack Overflow. Vi läser dokumentation. Massor av dokumentation. De flesta läser dokumentation i en webbläsare, men det finns ett bättre sätt. Möt Dash.

Dash och dokumentation

Dash är en app som lokalt cachar dokumentation från Internet och låter dig komma åt den via en specifik webbapplikation. Den kan hämtas från utvecklarens webbplats. Skillnaden mellan gratis och betald är minimal, den fria versionen levereras med väntetid vid uppstart och när du växlar mellan dokumentationssatser (dokument) och kommer att nagla dig för att köpa det.

Om du väljer att uppgradera till den betalda versionen av Dash kan du åtminstone använda den på så många Mac-datorer som du äger (ett obegränsat antal, enligt utvecklarna).

Dashs värdeförslag bygger på antalet bibliotek och språk som den stöder, och det är här det lyser.

Nästan alla språk, API och bibliotek du kan tänka på är representerade, liksom några du nog inte hört talas om. Både webb, mobil och system är väl representerade här.

Personligen utvecklar jag för webben både i front- och back-end-kapacitet, och allt jag använder är närvarande här. Tyvärr är kvaliteten på dokumentationen lite av en blandad väska.

Kvaliteten på dokumentation

Utvecklarna skapade inte själva dokumentationen, så det är inte riktigt deras fel. Precis som jag sa tidigare cachar Dash endast befintlig dokumentation.

Problemet är att vissa språk inte bara är väl dokumenterade - precis som den förenklade JavaScript-motgiften CoffeeScript CoffeeScript är JavaScript utan huvudvärk CoffeeScript är JavaScript utan huvudvärk Jag har aldrig velat skriva JavaScript så mycket. Från den dagen jag skrev min första raden med det, har jag alltid ångrat att det jag skriver i det alltid slutar se ut som en Jackson ... Läs mer. Deras dokumentation är mer av en “Är det inte så coolt??” hur-guida, visar exempel på språket i åtgärd utan att förklara faktiskt på vilket sätt saker fungerar.

Dessutom, när det gäller CoffeeScript, ser det inte bra ut i Dash. Det är mycket bättre anpassat till en webbläsare.

Med det sagt, fungerar vissa dokumentationssatser mycket bra, som de för Ruby. Det här är det språk som styr Ruby On Rails webbapplikationsramen. 3 Interaktiva, roliga och fria sätt att börja lära sig Ruby Programming Language 3 Interaktiva, roliga och fria sätt att börja lära sig Ruby Programming Language Ruby är en uttrycksfull, mycket hög nivå , skriptspråk. Den används på webben huvudsakligen som en del av Ruby on Rails webbutvecklingsram, men också fristående. Om du är nyfiken på vad Ruby (inte ... Läs mer, har fullständig sökbar dokumentation och passar snyggt inom Dash-estetiken.

Det finns också fuskplattor tillgängliga för nedladdning i Dash. Dessa fokuserar inte på språkfunktioner, utan snarare på de avancerade funktionerna i Git, personalens favorittextredigerare. Sublim Text 2 Prova Sublime Text 2 för dina Cross-Platform-kodredigeringsbehov Testa Sublim Text 2 för din Cross-Platform Code Editing Behöver Sublime Text 2 en krypplattformskodredigerare som jag bara hört talas om, och jag måste säga att jag är riktigt imponerad trots beta-etiketten. Du kan ladda ner hela appen utan att betala ett öre ... Läs mer och 3 och andra populära mjukvarupaket.

Cheat sheets är också tillgängliga för HTTP-funktioner, HTML och CSS Named Colors.

Tillgänglighet

Jag vet många utvecklare som kämpar för att läsa svart text på vita bakgrunder. Vissa bär även speciellt tonade glasögon för att underlätta för dem att läsa. Vissa behöver bara förstora text.

Jag har inte hittat några specifika tillgänglighetsinställningar i Dash, och jag har inte heller hittat något för att öka storleken på texten. Det kan vara en avtalsbrytare för vissa synskadade användare. OS X kommer dock med vissa tillgänglighetsfunktioner (Systeminställningar> System> Tillgänglighet) vilket kan göra Dash lite mer användbar.

Slutsats

Ska du få den betalda versionen av Dash? Det beror på. Det finns inte riktigt några övertygande funktioner som gör uppgraderingen värt kostnaden, men du kommer att stödja projektet genom att chippa in.

Jag använder den fria versionen av Dash på en daglig basis. Om du slingar kod för ett boende och äger en Mac behöver du den här appen. Det är inte perfekt, men det blir jobbet gjort.

Ladda ner: Dash för Mac OS X (gratis, 19,99 USD för fullversion)

Vad tror du? Ladda ner det och låt oss veta dina tankar i kommentarerna nedan.

Fotokredit: Kod (Michael Himbeault)

Utforska mer om: Digitalt dokument, programmering.