Microsoft Docs -sisällöntuottajan oppaan yleiskatsaus

Tervetuloa Microsoft Docs osallistujan oppaaseen!

Suurin osa Microsoftin tuottamasta dokumentaatiosisällöstä on avointa ja saatavilla GitHub-palvelussa. Kaikki dokumentit eivät ole täysin avoin lähdekoodi, mutta monissa säilöissä on julkisia säilöjä, joissa voit ehdottaa muutoksia pull-pyyntöjen (PR) kautta. Tämä avoimen lähdekoodin lähestymistapa virtaviivaistaa ja parantaa tuotesuunnisoijien, sisältötyöryhmien ja asiakkaiden välistä viestintää, ja siihen liittyy muitakin etuja:

  • Avoimet säilöt suunnittelevat avoimesti ja saavat palautetta tarvittavista asiakirjoista.
  • Avoimet säilöt tarkistavat avoimesti ja voivat julkaista tärkeimmän ohjesisällön heti ensimmäisestä julkaisuversiosta.
  • Avoimet säilöt päivittävät avoimesti ja voivat jatkuvasti parantaa sisältöä.

Microsoft Docs käyttökokemus integroituu suoraan GitHub-työnkulkuihin, mikä helpottaa työskentelyä entisestään. Aloita muokkaamalla tarkasteltavaa asiakirjaa. Voit myös auttaa tarkastelemalla uusia aiheita tai luomalla laatuongelmia.

Tärkeä

Kaikki Microsoft Docs julkaistavat säilöt ovat ottaneet käyttöön Microsoft Open Source -toimintasäännöt tai .NET Foundation -toimintasäännöt. Lisätietoja on ohjeaiheessa Toimintasääntöjen usein kysytyt kysymykset. Ota yhteyttä opencode@microsoft.com osoitteeseen tai conduct@dotnetfoundation.org kysy kysymyksiä tai kommentteja.

Pienet korjaukset ja selvennykset dokumentaatioon ja julkisten säilöjen koodiesimerkit ovat docs.microsoft.comin käyttöehtojen alaisia. Uudet tai merkittävät muutokset luovat pull-pyyntöön kommentin, jossa sinua pyydetään lähettämään osallistujien lisenssisopimus (CLA) verkossa, jos et ole Microsoftin työntekijä. Verkkolomake on täytettävä ennen pull-pyynnön tarkistamista tai hyväksymistä.

Nopeat muutokset dokumentaatioon

Nopeat muutokset tehostavat raportointiprosessia ja pienten virheiden ja puutteiden korjaamista ohjeissa. Kirjoittajat ovat vain ihmisiä, joten julkaistut asiakirjat voivat sisältää pieniä kielioppi- tai oikeinkirjoitusvirheitä. Voit raportoida virheistä ilmoittamalla ongelmasta, mutta nopeampi tapa on luoda pull-pyyntö ongelman korjaamiseksi, kun vaihtoehto on käytettävissä.

  1. Joidenkin asiakirjojen sivuilla voit tehdä muutoksia suoraan selaimen kautta. Jos näin on, näet alla olevan kaltaisen Muokkaa-painikkeen. Kun valitset Muokkaa -painikkeen (tai vastaavan lokalisoidun painikkeen), siirryt lähdetiedostoon GitHubissa.

    Muokkaa artikkelia -linkin sijainti.

    Jos Muokkaa-painiketta ei ole, se tarkoittaa, että sisältö ei ole avoin julkisille osallistumisille. Joitakin sivuja luodaan (esimerkiksi koodin sisäisestä dokumentaatiosta) ja niitä on muokattava projektissa, johon ne kuuluvat.

  2. Muokkaa artikkelia valitsemalla kynäkuvake. Jos kynäkuvake näkyy harmaana, sinun on joko kirjauduttava GitHub-tiliisi tai luotava uusi tili.

    Haarukka- ja muokkaa-kynäkuvakkeen sijainti.

  3. Muokkaa tiedostoa verkkoeditorissa. Tarkista muutosten muotoilu valitsemalla Esikatselu-välilehti .

  4. Kun olet lopettanut muokkauksen, siirry sivun alareunaan. Kirjoita Ehdota muutoksia -alueelle otsikko ja halutessasi kuvaus muutoksillesi. Otsikko on vahvistusviestin ensimmäinen rivi. Vahvista muutokset valitsemalla Ehdota muutoksia :

    Ehdota ja vahvista tiedoston muutoksia.

  5. Nyt kun olet ehdottanut ja sitoutunut muutoksiisi, sinun on pyydettävä säilön omistajia noutamaan tekemäsi muutokset säilöön. Tämä tapahtuu käyttämällä niin sanottua pull-pyyntöä (PR). Kun valitset Ehdota muutoksia, näkyviin tulee seuraava uusi sivu:

    Vertaa muutoksia ja luo pull-pyyntö.

    Valitse Luo pull-pyyntö. Kirjoita seuraavaksi pull-pyynnölle otsikko ja kuvaus ja valitse sitten Luo pull-pyyntö. Jos et ole aiemmin käyttänyt GitHubia, katso lisätietoja kohdasta Tietoja pull-pyynnöistä .

  6. Se oli siinä! Sisältötiimin jäsenet tarkistavat pull-pyyntösi ja yhdistävät sen, kun se hyväksytään. Saatat saada palautetta, jossa pyydetään muutoksia.

GitHubin editointikäyttöliittymä vastaa käyttäjän säilön oikeuksia. Edellä olevat kuvat on tarkoitettu osallistujille, joilla ei ole kohdesäilön kirjoitusoikeuksia. GitHub luo automaattisesti haarauman tilisi kohdesäilöstä. Juuri luodulla haaraumalla on oletusarvoisesti lomake GitHubUsername/RepositoryName . Jos sinulla on kohdesäilön, kuten haarautumisen, kirjoitusoikeudet, GitHub luo kohdesäilöön uuden haaran. Haaran nimellä on oletusarvoinen lomakkeen korjaustiedoston, joka käyttää haaralle numeerista tunnistetta.

Pull-pyyntöjä käytetään kaikissa muutoksissa riippumatta siitä, onko osallistujalla kirjoitusoikeuksia. Useimmat säilöt suojaavat oletushaaraa niin, että päivitykset on lähetettävä PULL-pyynnön muodossa.

Ainoastaan pienempiä muutoksia kannattaa tehdä suoraan selaimessa. Jos lisäät paljon sisältöä tai käytät edistyneitä Git-ominaisuuksia (kuten haaranhallintaa tai edistynyttä ristiriitojen ratkaisumenetelmää), sinun on luotava säilöön haarauma ja työskenneltävä paikallisesti.

Huomautus

Useimmat lokalisoidut ohjeet eivät tarjoa mahdollisuutta muokata tai antaa palautetta GitHubin kautta. Jos haluat antaa palautetta lokalisoidusta sisällöstä, käytä sähköpostimallia, joka on saatavilla osoitteessa aka.ms/DocSiteLocFeedback.

Avointen pull-pyyntöjen tarkastaminen

Voit lukea uusia aiheita ennen niiden julkaisua tarkistamalla avoimen PULL-pyynnön jonon. Tarkastukset noudattavat GitHub-työnkulun prosessia. Julkisissa säilöissä voit tarkastella ehdotettuja päivityksiä ja uusia artikkeleita. Tarkasta ne ja jätä tarvittaessa kommentteja. Katso mitä tahansa asiakirjasäilöämme ja tarkista avoimet PR:t sinua kiinnostavilta alueilta. Yhteisön palaute ehdotetuista päivityksistä auttaa koko yhteisöä.

Laatuongelmista ilmoittaminen

Työstämme jatkuvasti dokumentaatiotamme. Ongelmista ilmoittaminen auttaa meitä keskittymään yhteisön kannalta tärkeimpiin ongelmiin. Mitä enemmän tietoja voit antaa, sitä helpommin voimme korjata ongelman. Kerro, mitä tietoja hait. Kerro meille käyttämäsi hakuehdot. Jos et pääse alkuun, kerro meille miten haluaisit aloittaa vieraaseen tekniikkaan tutustumisen.

Monilla Microsoftin dokumentaatiosivuilla on sivun alareunassa Palaute-osio , jonka kautta voit antaa palautetta tuotteista tai palautetta sisällöstä , jotka liittyvät kyseiseen artikkeliin.

Ongelmista ilmoittaminen synnyttää keskustelua tarvittavista toimista. Sisältötyöryhmä voi reagoida ongelmiin ideoilla siitä, mitä voimme lisätä, ja kysyä yhteisön mielipiteitä. Luodessamme luonnosta voimme pyytää sinua tarkastamaan pull-pyynnön.

Yhteisön osallistaminen

Tämän oppaan muut aiheet auttavat sinua osallistumaan Microsoft Docs tehokkaasti. Niissä kerrotaan GitHub-säilöissä työskentelystä, Markdown-työkaluista ja Microsoft Docs ympäristössä käytettävistä laajennuksista.