Sanasto
Sanasto: Rakenteilla 🚧
Sanastomme on vielä keskeneräinen, mutta lisäämme jatkuvasti uusia määritelmiä. Pysy kuulolla saadaksesi lisää!
A
Lisäosa
Lisäominaisuus tai moduuli, joka voidaan integroida Archbeehen sen ominaisuuksien laajentamiseksi, kuten AI Addon edistyneitä AI-toimintoja varten.
Dokumentoi API-päätepisteesi selkeästi ja tarjoa olennaiset tiedot sekä kehittäjille että käyttäjille.
B
Lohkot
Dokumenttienne rakennuspalikat. Ajatelkaa niitä sisältönne Legoina. Voitte käyttää niitä otsikoiden, taulukoiden, kuvien, koodiesimerkkien ja muun luomiseen. Valittavana on perus-, media-, kehittäjä- ja upotettuja lohkoja.
Painike
Interaktiiviset painikkeet, jotka linkittävät muihin sisäisiin tai ulkoisiin sivuihin ja ohjaavat käyttäjiä dokumentaationne tai dokumentaation ulkopuolisen sisältönne läpi.
C
Kehotus
Korostakaa tärkeitä huomioita, vinkkejä tai varoituksia visuaalisesti erottuvilla huomiolohkoilla kiinnittääksenne huomion keskeisiin tietoihin.
Pitäkää käyttäjänne ajan tasalla muutoslokilohkolla, joka dokumentoi projektinne päivitykset ja muutokset.
Monikielinen koodieditori koodiesimerkkien esittelyyn, täydellinen kehittäjille.
Järjestäkää koodiesimerkkinne laatikoihin ja näyttäkää ne rinnakkain sisältönne kanssa pitäen dokumentaationne siistinä ja käyttäjäystävällisenä.
Luokaa uudelleenkäytettäviä sisältölohkoja, jotka voidaan lisätä useisiin dokumentteihin, mikä varmistaa yhdenmukaisuuden ja säästää aikaa.
D
E
Muokkain
Tärkein paikkasi sisällön luomiseen ja muokkaamiseen. Se on kuin digitaalinen työtila, jossa voit käyttää pikanäppäimiä, lisätä erilaisia sisältölohkoja ja muotoilla tekstiäsi käyttämällä Markdownia tai WYSIWYG-valikkoa. Voit myös upottaa sisältöä muista työkaluista ja linkittää muihin dokumentteihin. Ajattele sitä keskitettynä paikkana kaikkeen sisällöntuotantoon liittyvään!
Integroi sisältöä suosituista työkaluista, kuten Loom, Figma ja Miro, suoraan dokumentaatioosi yhtenäisen käyttökokemuksen luomiseksi.
Osioita, joita voidaan laajentaa tai kutistaa, mikä helpottaa monimutkaisten aiheiden navigointia.
F
Tiedosto
Lataa ja linkitä tiedostoja suoraan dokumentaatiossasi, jolloin resurssit ovat helposti käyttäjien saatavilla.
Järjestä ja hallitse kaikkia tiedostojasi yhdessä keskitetysti, mikä helpottaa resurssien lataamista, käyttämistä ja linkittämistä dokumentaatiossasi.
G
GraphQL
Dokumentoi GraphQL API:t tehokkaasti ja tarjoa käyttäjille tiedot, joita he tarvitsevat palveluidesi kanssa toimimiseen.
H
Otsikot
Käytetään otsikoiden ja alaotsikoiden luomiseen sisällön hierarkkista järjestämistä varten.
Vaakajakajat auttavat luomaan visuaalisia katkoksia osioiden väliin ja parantavat dokumentaation rakennetta.
I
Kuva
Rikastuta dokumentaatiotasi kuvilla lisäämällä visuaalista kontekstia ja kiinnostavuutta sisältöösi
J
K
L
Luo dynaamisia linkkejä muihin dokumentteihin tai ulkoisiin resursseihin, mikä helpottaa sisällössä navigointia.
Käytä järjestettyjä ja järjestämättömiä luetteloita jakaaksesi tiedot helposti omaksuttaviin kohtiin ja parantaaksesi luettavuutta.
M
Kartta
Integroi karttoja sijaintipohjaisten tietojen näyttämiseen, mikä parantaa sisältösi merkityksellisyyttä.
Luo vuokaavioita ja diagrammeja Mermaid-syntaksin avulla ja lisää visuaalisia apuvälineitä dokumentaatioosi.
Järjestä tehtävät hallittaviin alatehtäviin Minitaskersin avulla, joka on saanut inspiraationsa Trellosta, jotta projektisi pysyvät aikataulussa.
N
O
P
Q
R
Uudelleenkäytettävät
Luo ja hallitse uudelleenkäytettäviä sisältölohkoja, jotka voidaan lisätä useisiin dokumentteihin. Tämä varmistaa yhdenmukaisuuden ja säästää aikaa dokumentaatiossasi.
S
Tilat
Tiimien tai projektien mukaan järjestettyjen dokumenttien säilöt. Jokaisella tilillä on henkilökohtainen tila, ja organisaatiot voivat luoda mukautettuja tiloja käyttöoikeuksien hallinnalla.
Ajattele niitä Tilojesi kansioina. Aloitat yhdellä kansiolla nimeltä "Spaces." Luo lisää kansioita tarpeen mukaan. Voit lisätä, nimetä uudelleen tai poistaa kansioita (mutta vain, jos ne ovat tyhjiä). Voit sijoittaa Tilan kansioon vetämällä sen sinne, käyttämällä siirtotoimintoa tai luomalla sen kansioon.
Yhdistä useita julkaistuja Tiloja dokumenttien välisen navigoinnin helpottamiseksi (esimerkiksi käyttöoppaat ja API-dokumentaatio). Lisää linkkejä Tilan asetuksiin, nimeä ne ja julkaise. Linkkien muutokset päivittyvät automaattisesti kaikissa yhdistetyissä Tiloissa.
Integroi OpenAPI-määritykset saumattomasti parantaaksesi API-dokumentaatiotasi.
T
Taulukko
Käytä taulukkolohkoa esittääksesi tiedot selkeällä ja järjestelmällisellä tavalla. Se sopii täydellisesti vertailuihin ja rakenteiseen tietoon.
Järjestä sisältö useisiin välilehtiin siistiä ja tehokasta navigointikokemusta varten, jolloin käyttäjät voivat vaihtaa aiheiden välillä helposti.
Renderöi monimutkaisia matemaattisia yhtälöitä käyttäen TeX:iä, mikä tekee dokumentaatiostasi sopivan teknisiin aiheisiin.
U
Käyttäjäryhmät
Ovat kuin osastoja käyttäjillesi. Voit luoda eri ryhmiä (kuten Engineers, Marketing tai Management) ja määrittää käyttäjiä niihin. Tämä auttaa sinua järjestämään käyttäjäsi ja antamaan heille eri käyttöoikeustasoja organisaatiosi eri osiin.
V
Esittele sisältöä rinnakkain pystysuuntaisella jakolohkolla, joka on ihanteellinen vertailuihin tai liittyviin tietoihin.
Video
W
Visualisoi prosesseja ja työnkulkuja tällä lohkolla, mikä auttaa käyttäjiä ymmärtämään vaiheet ja järjestykset selkeästi.
Käyttäjäystävällinen "What You See Is What You Get" -valikko, jonka avulla voit muotoilla sisältöäsi visuaalisesti, tehden dokumenttien luomisesta intuitiivista ja suoraviivaista.
X
Y
Z
Tässä on brändätty luettelo Archbeen lisäominaisuuksista kuvauksineen:
Archbee Reusables
- Uudelleenkäytettävät: Luo ja hallitse uudelleenkäytettäviä sisältölohkoja, jotka voidaan lisätä useisiin asiakirjoihin, varmistaen yhdenmukaisuuden ja säästäen aikaa dokumentaatiossasi.
Archbee File Manager
- Tiedostonhallinta: Järjestä ja hallitse kaikkia tiedostojasi yhdessä keskitetystä sijainnista, mikä helpottaa resurssien lataamista, käyttöä ja linkittämistä dokumentaatiossasi.
Archbee Markdown
- Markdown: Hyödynnä Markdown-syntaksia tekstin muotoiluun nopeasti ja tehokkaasti, mahdollistaen virtaviivaisen kirjoituskokemuksen samalla säilyttäen joustavuuden asiakirjojen suunnittelussa.
Archbee WYSIWYG Menu
- WYSIWYG-valikko: Käytä käyttäjäystävällistä "What You See Is What You Get" -editoria, jonka avulla voitte muotoilla sisältöä visuaalisesti, tehden asiakirjojen luomisesta intuitiivista ja suoraviivaista.
Archbee Emojis
- Emojit: Paranna dokumentaatiotasi emojeilla lisätäksesi persoonallisuutta ja visuaalista kiinnostavuutta, tehden sisällöstäsi käyttäjille kiinnostavampaa ja helpommin lähestyttävää.
Archbee Drag & Drop
- Vedä ja pudota: Järjestele lohkoja ja sisältöä helposti uudelleen asiakirjoissasi yksinkertaisen vedä ja pudota -käyttöliittymän avulla, mahdollistaen nopeat muutokset ja organisoinnin.
Archbee Variables
- Muuttujat: Käytä muuttujia lisätäksesi dynaamista sisältöä, joka voi muuttua kontekstin perusteella, tehden dokumentaatiostasi mukautuvaa ja personoitua eri käyttäjille.
Archbee Space-Specific Variables
- Tilakohtaiset muuttujat: Määritä tiettyihin tiloihin yksilöllisiä muuttujia, mikä mahdollistaa räätälöidyn sisällön, joka vastaa eri projektien tai tiimien tarpeisiin.
Archbee Glossary
- Sanasto: Luo sanasto termeistä tarjotaksesi määritelmiä ja selityksiä erikoissanastolle, parantaen käyttäjien ymmärrystä ja saavutettavuutta.
Archbee Docs Tagging
- Asiakirjojen tunnisteet: Järjestä asiakirjasi tunnisteilla helppoa luokittelua ja hakua varten, parantaen navigointia ja hakutoimintoja dokumentaatiossasi.
Archbee Display Rules
- Näyttösäännöt: Aseta ehtoja sille, milloin tietty sisältö tulisi näyttää tai piilottaa käyttäjäroolien tai muiden kriteerien perusteella, mahdollistaen mukautetun käyttäjäkokemuksen.
Archbee Find & Replace
- Etsi ja korvaa: Paikanna ja korvaa teksti nopeasti koko dokumentaatiossasi, virtaviivaistaen muokkausprosessia ja varmistaen yhdenmukaisuuden.
Archbee Notifications
- Ilmoitukset: Pysykää ajan tasalla reaaliaikaisten ilmoitusten avulla dokumentaationne päivityksistä, kommenteista ja muutoksista, pitäen teidät yhteydessä tiimiinne.
Archbee Notification Center
- Ilmoituskeskus: Käyttäkää keskitettyä keskusta kaikille ilmoituksillenne, jolloin voitte hallita ja tarkistaa päivityksiä tehokkaasti.
Archbee Comments
- Kommentit: Tehkää yhteistyötä tiiminne kanssa lisäämällä kommentteja suoraan asiakirjoihin, helpottaen keskusteluja ja palautetta tietystä sisällöstä.
Archbee Templates
- Mallit: Hyödyntäkää valmiiksi suunniteltuja malleja dokumentaatioprojektienne käynnistämiseen, varmistaen yhtenäisen ulkoasun ja käyttötuntuman koko sisällössänne.
Archbee Category
- Kategoria: Järjestä dokumenttinne kategorioihin paremman rakenteen ja helpomman navigoinnin saavuttamiseksi, mikä auttaa käyttäjiä löytämään olennaiset tiedot nopeasti.
Archbee-dokumenttihistoria
- Dokumenttihistoria: Seuratkaa dokumentteihinne ajan myötä tehtyjä muutoksia ja versioita, jolloin voitte tarvittaessa palauttaa aiemmat versiot.
Archbee-tarkistusjärjestelmä
- Tarkistusjärjestelmä: Ottakaa käyttöön strukturoitu dokumenttien tarkistusprosessi, joka varmistaa laadun ja tarkkuuden ennen julkaisemista.
Archbee-dokumenttien varmennus
- Varmenna dokumentit: Varmistakaa dokumentaationne eheys ja tarkkuus varmentamalla sisältö määritettyjä standardeja tai ohjeistuksia vasten.
Archbee-piilotetut dokumentit
- Piilotetut dokumentit: Pitäkää tietyt dokumentit yksityisinä tai käyttäjiltä piilotettuina samalla, kun niiden indeksointi hakua varten edelleen sallitaan, jotta luottamuksellisuus säilyy.
Nämä ominaisuudet antavat teille mahdollisuuden luoda, hallita ja työstää dokumentaatiota yhdessä tehokkaasti ja parantavat samalla yleistä käyttökokemusta Archbeessä.